eolib-cpp 0.1.0-beta.7
Core C++ library for writing Endless Online applications
Loading...
Searching...
No Matches
eolib::protocol::net::server::MarriageReplyServerPacket Class Referencefinal

Reply to client Marriage-family packets. More...

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

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

Classes

class  ReplyCodeDataSuccess
 Data associated with reply_code value Success. More...

Public Types

using ReplyCodeData = std::variant<std::monostate, ReplyCodeDataSuccess>
 Data associated with different values of the reply_code field.

Public Member Functions

const ReplyCodeDataSuccess * AsSuccess () const noexcept
 Gets the data associated with reply_code value Success.
ReplyCodeDataSuccess * AsSuccess () noexcept
 Gets the data associated with reply_code value Success.
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 MarriageReplyServerPacket &other) const
 Compares this object with another for equality.
bool operator!= (const MarriageReplyServerPacket &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 MarriageReplyServerPacket ForAlreadyMarried ()
 Creates a new MarriageReplyServerPacket with reply_code set to AlreadyMarried.
static MarriageReplyServerPacket ForNotMarried ()
 Creates a new MarriageReplyServerPacket with reply_code set to NotMarried.
static MarriageReplyServerPacket ForSuccess (ReplyCodeDataSuccess data)
 Creates a new MarriageReplyServerPacket with reply_code set to Success.
static MarriageReplyServerPacket ForNotEnoughGold ()
 Creates a new MarriageReplyServerPacket with reply_code set to NotEnoughGold.
static MarriageReplyServerPacket ForWrongName ()
 Creates a new MarriageReplyServerPacket with reply_code set to WrongName.
static MarriageReplyServerPacket ForServiceBusy ()
 Creates a new MarriageReplyServerPacket with reply_code set to ServiceBusy.
static MarriageReplyServerPacket ForDivorceNotification ()
 Creates a new MarriageReplyServerPacket with reply_code set to DivorceNotification.

Public Attributes

MarriageReply reply_code {}
ReplyCodeData reply_code_data {}
 Data associated with the reply_code field.

Static Public Attributes

static constexpr PacketFamily FAMILY = PacketFamily::Marriage
 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

Reply to client Marriage-family packets.

Member Typedef Documentation

◆ ReplyCodeData

Data associated with different values of the reply_code field.

Member Function Documentation

◆ AsSuccess() [1/2]

const ReplyCodeDataSuccess * eolib::protocol::net::server::MarriageReplyServerPacket::AsSuccess ( ) const
inlinenoexcept

Gets the data associated with reply_code value Success.

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

◆ AsSuccess() [2/2]

ReplyCodeDataSuccess * eolib::protocol::net::server::MarriageReplyServerPacket::AsSuccess ( )
inlinenoexcept

Gets the data associated with reply_code value Success.

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

◆ ForAlreadyMarried()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForAlreadyMarried ( )
static

Creates a new MarriageReplyServerPacket with reply_code set to AlreadyMarried.

Returns
the created object.

◆ ForNotMarried()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForNotMarried ( )
static

Creates a new MarriageReplyServerPacket with reply_code set to NotMarried.

Returns
the created object.

◆ ForSuccess()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForSuccess ( ReplyCodeDataSuccess data)
static

Creates a new MarriageReplyServerPacket with reply_code set to Success.

Parameters
datathe data associated with reply_code Success.
Returns
the created object.

◆ ForNotEnoughGold()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForNotEnoughGold ( )
static

Creates a new MarriageReplyServerPacket with reply_code set to NotEnoughGold.

Returns
the created object.

◆ ForWrongName()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForWrongName ( )
static

Creates a new MarriageReplyServerPacket with reply_code set to WrongName.

Returns
the created object.

◆ ForServiceBusy()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForServiceBusy ( )
static

Creates a new MarriageReplyServerPacket with reply_code set to ServiceBusy.

Returns
the created object.

◆ ForDivorceNotification()

MarriageReplyServerPacket eolib::protocol::net::server::MarriageReplyServerPacket::ForDivorceNotification ( )
static

Creates a new MarriageReplyServerPacket with reply_code set to DivorceNotification.

Returns
the created object.

◆ Family()

PacketFamily eolib::protocol::net::server::MarriageReplyServerPacket::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::MarriageReplyServerPacket::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::MarriageReplyServerPacket::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::MarriageReplyServerPacket::Serialize ( data::EoWriter & writer) const
overridevirtual

Serializes this object to the provided writer.

Parameters
writerthe writer that the data will be written to.
Exceptions
SerializationErrorif the object's data is invalid for serialization.

Implements eolib::protocol::Serializable.

◆ Deserialize()

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

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

Parameters
readerthe reader that the data will be read from.

Implements eolib::protocol::Serializable.

◆ ToString()

std::string eolib::protocol::net::server::MarriageReplyServerPacket::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::MarriageReplyServerPacket::operator== ( const MarriageReplyServerPacket & other) const

Compares this object with another for equality.

The deserialized byte size is not compared.

Parameters
otherthe object to compare with.
Returns
true if all fields are equal, otherwise false.

◆ operator!=()

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

Compares this object with another for inequality.

The deserialized byte size is not compared.

Parameters
otherthe object to compare with.
Returns
true if any field differs, otherwise false.

Member Data Documentation

◆ FAMILY

PacketFamily eolib::protocol::net::server::MarriageReplyServerPacket::FAMILY = PacketFamily::Marriage
staticconstexpr

The packet family associated with this packet.

◆ ACTION

PacketAction eolib::protocol::net::server::MarriageReplyServerPacket::ACTION = PacketAction::Reply
staticconstexpr

The packet action associated with this packet.

◆ reply_code

MarriageReply eolib::protocol::net::server::MarriageReplyServerPacket::reply_code {}

◆ reply_code_data

ReplyCodeData eolib::protocol::net::server::MarriageReplyServerPacket::reply_code_data {}

Data associated with the reply_code field.