eolib::protocol::net::client::SitRequestClientPacket Class Reference

Sit/stand request. More...

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

Inherits eolib::protocol::net::Packet.

Classes
class	SitActionDataSit
	Data associated with sit_action value Sit. More...

Public Types
using	SitActionData = std::variant<std::monostate, SitActionDataSit>
	Data associated with different values of the sit_action field.

Public Member Functions
const SitActionDataSit *	AsSit () const noexcept
	Gets the data associated with sit_action value Sit.
SitActionDataSit *	AsSit () noexcept
	Gets the data associated with sit_action value Sit.
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 SitRequestClientPacket &other) const
	Compares this object with another for equality.
bool	operator!= (const SitRequestClientPacket &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 SitRequestClientPacket	ForSit (SitActionDataSit data)
	Creates a new SitRequestClientPacket with sit_action set to Sit.
static SitRequestClientPacket	ForStand ()
	Creates a new SitRequestClientPacket with sit_action set to Stand.

Public Attributes
SitAction	sit_action {}
SitActionData	sit_action_data {}
	Data associated with the sit_action field.

Static Public Attributes
static constexpr PacketFamily	FAMILY = PacketFamily::Sit
	The packet family associated with this packet.
static constexpr PacketAction	ACTION = PacketAction::Request
	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

Sit/stand request.

Member Typedef Documentation

SitActionData

using eolib::protocol::net::client::SitRequestClientPacket::SitActionData = std::variant<std::monostate, SitActionDataSit>

Data associated with different values of the sit_action field.

Member Function Documentation

AsSit() [1/2]

const SitActionDataSit * eolib::protocol::net::client::SitRequestClientPacket::AsSit ( ) const

inlinenoexcept

Gets the data associated with sit_action value Sit.

Returns

the data, or nullptr if sit_action_data holds the data for a different value.

AsSit() [2/2]

SitActionDataSit * eolib::protocol::net::client::SitRequestClientPacket::AsSit ( )

inlinenoexcept

Gets the data associated with sit_action value Sit.

Returns

the data, or nullptr if sit_action_data holds the data for a different value.

ForSit()

SitRequestClientPacket eolib::protocol::net::client::SitRequestClientPacket::ForSit ( SitActionDataSit data )

static

Creates a new SitRequestClientPacket with sit_action set to Sit.

Parameters

data	the data associated with sit_action Sit.

Returns

the created object.

ForStand()

SitRequestClientPacket eolib::protocol::net::client::SitRequestClientPacket::ForStand ( )

static

Creates a new SitRequestClientPacket with sit_action set to Stand.

Returns

the created object.

Family()

PacketFamily eolib::protocol::net::client::SitRequestClientPacket::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::client::SitRequestClientPacket::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::client::SitRequestClientPacket::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::client::SitRequestClientPacket::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::client::SitRequestClientPacket::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::client::SitRequestClientPacket::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::client::SitRequestClientPacket::operator==

(

const SitRequestClientPacket &

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::client::SitRequestClientPacket::operator!=

(

const SitRequestClientPacket &

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::client::SitRequestClientPacket::FAMILY = PacketFamily::Sit

staticconstexpr

The packet family associated with this packet.

ACTION

PacketAction eolib::protocol::net::client::SitRequestClientPacket::ACTION = PacketAction::Request

staticconstexpr

The packet action associated with this packet.

sit_action

SitAction eolib::protocol::net::client::SitRequestClientPacket::sit_action {}

sit_action_data

SitActionData eolib::protocol::net::client::SitRequestClientPacket::sit_action_data {}

Data associated with the sit_action field.