Incoming admin message. More...

#include <eolib/protocol/net/server/packets.hpp>

Classes
class	MessageTypeDataMessage
	Data associated with message_type value Message. More...
class	MessageTypeDataReport
	Data associated with message_type value Report. More...

Public Types
using	MessageTypeData = std::variant<std::monostate, MessageTypeDataMessage, MessageTypeDataReport>
	Data associated with different values of the message_type field.

Public Member Functions
const MessageTypeDataMessage *	AsMessage () const noexcept
	Gets the data associated with message_type value Message.
MessageTypeDataMessage *	AsMessage () noexcept
	Gets the data associated with message_type value Message.
const MessageTypeDataReport *	AsReport () const noexcept
	Gets the data associated with message_type value Report.
MessageTypeDataReport *	AsReport () noexcept
	Gets the data associated with message_type value Report.
PacketFamily	Family () const noexcept override
	Gets the packet family associated with this packet.
PacketAction	Action () const noexcept override
	Gets the packet action associated with this packet.
int	ByteSize () const noexcept override
	Gets the size of the data that this object was deserialized from.
void	Serialize (data::EoWriter &writer) const override
	Serializes this object to the provided writer.
void	Deserialize (data::EoReader &reader) override
	Deserializes this object from the provided reader, replacing its current data.
std::string	ToString () const override
	Gets a human-readable representation of this object, for debugging purposes.
bool	operator== (const AdminInteractReplyServerPacket &other) const
	Compares this object with another for equality.
bool	operator!= (const AdminInteractReplyServerPacket &other) const
	Compares this object with another for inequality.
Public Member Functions inherited from eolib::protocol::Serializable
virtual	~Serializable ()=default

Static Public Member Functions
static AdminInteractReplyServerPacket	ForMessage (MessageTypeDataMessage data)
	Creates a new AdminInteractReplyServerPacket with message_type set to Message.
static AdminInteractReplyServerPacket	ForReport (MessageTypeDataReport data)
	Creates a new AdminInteractReplyServerPacket with message_type set to Report.

Public Attributes
AdminMessageType	message_type {}
MessageTypeData	message_type_data {}
	Data associated with the message_type field.

Static Public Attributes
static constexpr PacketFamily	FAMILY = PacketFamily::AdminInteract
	The packet family associated with this packet.
static constexpr PacketAction	ACTION = PacketAction::Reply
	The packet action associated with this packet.

Additional Inherited Members
Protected Member Functions inherited from eolib::protocol::Serializable
	Serializable ()=default
	Serializable (const Serializable &)=default
	Serializable (Serializable &&)=default
Serializable &	operator= (const Serializable &)=default
Serializable &	operator= (Serializable &&)=default

Detailed Description

Incoming admin message.

Member Typedef Documentation

◆ MessageTypeData

using eolib::protocol::net::server::AdminInteractReplyServerPacket::MessageTypeData = std::variant<std::monostate, MessageTypeDataMessage, MessageTypeDataReport>

Data associated with different values of the message_type field.

Member Function Documentation

◆ AsMessage() [1/2]

const MessageTypeDataMessage * eolib::protocol::net::server::AdminInteractReplyServerPacket::AsMessage ( ) const

inlinenoexcept

Gets the data associated with message_type value Message.

Returns: the data, or nullptr if message_type_data holds the data for a different value.

◆ AsMessage() [2/2]

MessageTypeDataMessage * eolib::protocol::net::server::AdminInteractReplyServerPacket::AsMessage ( )

inlinenoexcept

Gets the data associated with message_type value Message.

Returns: the data, or nullptr if message_type_data holds the data for a different value.

◆ AsReport() [1/2]

const MessageTypeDataReport * eolib::protocol::net::server::AdminInteractReplyServerPacket::AsReport ( ) const

inlinenoexcept

Gets the data associated with message_type value Report.

Returns: the data, or nullptr if message_type_data holds the data for a different value.

◆ AsReport() [2/2]

MessageTypeDataReport * eolib::protocol::net::server::AdminInteractReplyServerPacket::AsReport ( )

inlinenoexcept

Gets the data associated with message_type value Report.

Returns: the data, or nullptr if message_type_data holds the data for a different value.

◆ ForMessage()

AdminInteractReplyServerPacket eolib::protocol::net::server::AdminInteractReplyServerPacket::ForMessage ( MessageTypeDataMessage data )

static

Creates a new AdminInteractReplyServerPacket with message_type set to Message.

Parameters

data	the data associated with message_type Message.

Returns: the created object.

◆ ForReport()

AdminInteractReplyServerPacket eolib::protocol::net::server::AdminInteractReplyServerPacket::ForReport ( MessageTypeDataReport data )

static

Creates a new AdminInteractReplyServerPacket with message_type set to Report.

Parameters

data	the data associated with message_type Report.

Returns: the created object.

◆ Family()

PacketFamily eolib::protocol::net::server::AdminInteractReplyServerPacket::Family ( ) const

inlineoverridevirtualnoexcept

Gets the packet family associated with this packet.

Returns: the packet family.

Implements eolib::protocol::net::Packet.

◆ Action()

PacketAction eolib::protocol::net::server::AdminInteractReplyServerPacket::Action ( ) const

inlineoverridevirtualnoexcept

Gets the packet action associated with this packet.

Returns: the packet action.

Implements eolib::protocol::net::Packet.

◆ ByteSize()

int eolib::protocol::net::server::AdminInteractReplyServerPacket::ByteSize ( ) const

overridevirtualnoexcept

Gets the size of the data that this object was deserialized from.

Returns: the deserialized size in bytes, or 0 for an object that was not deserialized.

Implements eolib::protocol::Serializable.

◆ Serialize()

void eolib::protocol::net::server::AdminInteractReplyServerPacket::Serialize ( data::EoWriter & writer ) const

overridevirtual

Serializes this object to the provided writer.

Parameters

writer the writer that the data will be written to.

Exceptions

SerializationError if the object's data is invalid for serialization.

Implements eolib::protocol::Serializable.

◆ Deserialize()

void eolib::protocol::net::server::AdminInteractReplyServerPacket::Deserialize ( data::EoReader & reader )

overridevirtual

Deserializes this object from the provided reader, replacing its current data.

Parameters

reader the reader that the data will be read from.

Implements eolib::protocol::Serializable.

◆ ToString()

std::string eolib::protocol::net::server::AdminInteractReplyServerPacket::ToString ( ) const

overridevirtual

Gets a human-readable representation of this object, for debugging purposes.

Returns: the object's fields and values, as a string.

Implements eolib::protocol::Serializable.

◆ operator==()

bool eolib::protocol::net::server::AdminInteractReplyServerPacket::operator== ( const AdminInteractReplyServerPacket & other ) const

Compares this object with another for equality.

The deserialized byte size is not compared.

Parameters

other the object to compare with.

Returns: true if all fields are equal, otherwise false.

◆ operator!=()

bool eolib::protocol::net::server::AdminInteractReplyServerPacket::operator!= ( const AdminInteractReplyServerPacket & other ) const

Compares this object with another for inequality.

The deserialized byte size is not compared.

Parameters

other the object to compare with.

Returns: true if any field differs, otherwise false.

Member Data Documentation

◆ FAMILY

PacketFamily eolib::protocol::net::server::AdminInteractReplyServerPacket::FAMILY = PacketFamily::AdminInteract

staticconstexpr

The packet family associated with this packet.

◆ ACTION

PacketAction eolib::protocol::net::server::AdminInteractReplyServerPacket::ACTION = PacketAction::Reply

staticconstexpr

The packet action associated with this packet.

◆ message_type

AdminMessageType eolib::protocol::net::server::AdminInteractReplyServerPacket::message_type {}

◆ message_type_data

MessageTypeData eolib::protocol::net::server::AdminInteractReplyServerPacket::message_type_data {}

Data associated with the message_type field.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MessageTypeData

Member Function Documentation

◆ AsMessage() [1/2]

◆ AsMessage() [2/2]

◆ AsReport() [1/2]

◆ AsReport() [2/2]

◆ ForMessage()

◆ ForReport()

◆ Family()

◆ Action()

◆ ByteSize()

◆ Serialize()

◆ Deserialize()

◆ ToString()

◆ operator==()

◆ operator!=()

Member Data Documentation

◆ FAMILY

◆ ACTION

◆ message_type

◆ message_type_data