Net::MessageOut Class Reference

#include <messageout.h>

Inheritance diagram for Net::MessageOut:

Public Member Functions
virtual void	writeInt8 (const int8_t value, const char *const str)
void	writeInt16 (const int16_t value, const char *const str)
void	writeInt32 (const int32_t value, const char *const str)
void	writeItemId (const int32_t value, const char *const str)
void	writeInt64 (const int64_t value, const char *const str)
void	writeBeingId (const BeingId value, const char *const str)
void	writeCoordinates (const uint16_t x, const uint16_t y, unsigned char direction, const char *const str)
void	writeString (const std::string &string, int length, const char *const str)
void	writeStringNoLog (const std::string &string, int length, const char *const str)
void	writeFloat (const float value, const char *const str)
const char *	getData () const
unsigned int	getDataSize () const
virtual	~MessageOut ()
void	resetPos ()

Static Public Member Functions
static unsigned char	toServerDirection (unsigned char direction) A_CONST

Protected Member Functions
	MessageOut (const int16_t id)
virtual void	expand (size_t size) const =0

Protected Attributes
char *	mData
unsigned int	mDataSize
unsigned int	mPos
uint16_t	mId
bool	mIgnore

Detailed Description

Used for building an outgoing message.

Definition at line 48 of file messageout.h.

Constructor & Destructor Documentation

~MessageOut()

virtual Net::MessageOut::~MessageOut ( )

inlinevirtual

Reimplemented in TmwAthena::MessageOut, and EAthena::MessageOut.

Definition at line 108 of file messageout.h.

        { }

MessageOut()

Net::MessageOut::MessageOut ( const int16_t  id )

explicitprotected

Constructor.

Definition at line 49 of file messageout.cpp.

                                       :
    mData(nullptr),
    mDataSize(0),
    mPos(0),
    mId(id),
    mIgnore(false)
{
    PacketCounters::incOutPackets();
    IGNOREDEBUGLOG;
    DEBUGLOG2("Send packet", 0, "MessageOut");
}

References DEBUGLOG2, IGNOREDEBUGLOG, and PacketCounters::incOutPackets().

Member Function Documentation

expand()

virtual void Net::MessageOut::expand ( size_t  size ) const

protectedpure virtual

Expand the packet data to be able to hold more data.

NOTE: For performance enhancements this method could allocate extra memory in advance instead of expanding size every time more data is added.

Implemented in TmwAthena::MessageOut, and EAthena::MessageOut.

Referenced by writeCoordinates(), writeFloat(), writeInt16(), writeInt32(), writeInt64(), writeInt8(), writeString(), and writeStringNoLog().

getData()

const char * Net::MessageOut::getData

(

)

const

Returns the content of the message.

Definition at line 243 of file messageout.cpp.

{
    return mData;
}

References mData.

getDataSize()

unsigned int Net::MessageOut::getDataSize

(

)

const

Returns the length of the data.

Definition at line 248 of file messageout.cpp.

{
    return mDataSize;
}

References mDataSize.

resetPos()

void Net::MessageOut::resetPos ( )

inline

Definition at line 111 of file messageout.h.

        { mPos = 0; }

References mPos.

toServerDirection()

unsigned char Net::MessageOut::toServerDirection ( unsigned char  direction )

static

Definition at line 253 of file messageout.cpp.

{
    // Translate direction to eAthena format
    switch (direction)
    {
        case 1:  // DOWN
            direction = 0;
            break;
        case 3:  // DOWN | LEFT
            direction = 1;
            break;
        case 2:  // LEFT
            direction = 2;
            break;
        case 6:  // LEFT | UP
            direction = 3;
            break;
        case 4:  // UP
            direction = 4;
            break;
        case 12:  // UP | RIGHT
            direction = 5;
            break;
        case 8:  // RIGHT
            direction = 6;
            break;
        case 9:  // RIGHT + DOWN
            direction = 7;
            break;
        default:
            // OOPSIE! Impossible or unknown
            direction = CAST_U8(-1);
            break;
    }
    return direction;
}

References CAST_U8.

Referenced by EAthena::PlayerHandler::setDirection(), EAthena::HomunculusHandler::setDirection(), EAthena::MercenaryHandler::setDirection(), EAthena::PetHandler::setDirection(), and writeCoordinates().

writeBeingId()

void Net::MessageOut::writeBeingId	(	const BeingId	value,
		const char *const	str
	)

Definition at line 129 of file messageout.cpp.

{
    writeInt32(toInt(value, int32_t), str);
}

References toInt, and writeInt32().

writeCoordinates()

void Net::MessageOut::writeCoordinates	(	const uint16_t	x,
		const uint16_t	y,
		unsigned char	direction,
		const char *const	str
	)

Definition at line 148 of file messageout.cpp.

{
    DEBUGLOG2(strprintf("writeCoordinates: %u,%u %u",
        CAST_U32(x),
        CAST_U32(y),
        CAST_U32(direction)), mPos, str);
    unsigned char *const data = reinterpret_cast<unsigned char*>(mData)
        + CAST_SIZE(mPos);
    expand(3);
    mPos += 3;
 
    uint16_t temp = x;
    temp <<= 6;
    data[0] = 0;
    data[1] = 1;
    data[2] = 2;
    data[0] = HIBYTE(temp);
    data[1] = CAST_U8(temp);
    temp = y;
    temp <<= 4;
    data[1] |= HIBYTE(temp);
    data[2] = LOBYTE(temp);
    direction = toServerDirection(direction);
    data[2] |= direction;
}

References CAST_SIZE, CAST_U32, CAST_U8, data, DEBUGLOG2, expand(), HIBYTE, LOBYTE, mData, mPos, strprintf(), toServerDirection(), x, and y.

writeFloat()

void Net::MessageOut::writeFloat	(	const float	value,
		const char *const	str
	)

Definition at line 134 of file messageout.cpp.

{
#ifdef ENABLEDEBUGLOG
    std::string text = strprintf("writeFloat: %f", value);
    DEBUGLOG2(text, mPos, str);
#endif
    expand(4);
    memcpy(mData + CAST_SIZE(mPos), &value, sizeof(float));
    mPos += 4;
}

References CAST_SIZE, DEBUGLOG2, expand(), mData, mPos, and strprintf().

writeInt16()

void Net::MessageOut::writeInt16	(	const int16_t	value,
		const char *const	str
	)

Writes a long.

Definition at line 71 of file messageout.cpp.

{
    expand(2);
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
    int16_t swap = SDL_Swap16(value);
    memcpy(mData + CAST_SIZE(mPos), &swap, sizeof(int16_t));
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
    memcpy(mData + CAST_SIZE(mPos), &value, sizeof(int16_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
    DEBUGLOG2("writeInt16: " + toStringPrint(CAST_U32(
        CAST_U16(value))),
        mPos, str);
    mPos += 2;
}

References CAST_SIZE, CAST_U16, CAST_U32, DEBUGLOG2, expand(), mData, mPos, and toStringPrint().

Referenced by EAthena::ChatHandler::sendRaw(), TmwAthena::ChatHandler::sendRaw(), writeItemId(), writeString(), and writeStringNoLog().

writeInt32()

void Net::MessageOut::writeInt32	(	const int32_t	value,
		const char *const	str
	)

Definition at line 88 of file messageout.cpp.

{
    DEBUGLOG2("writeInt32: " + toStringPrint(CAST_U32(value)),
        mPos, str);
    expand(4);
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
    int32_t swap = SDL_Swap32(value);
    memcpy(mData + CAST_SIZE(mPos), &swap, sizeof(int32_t));
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
    memcpy(mData + CAST_SIZE(mPos), &value, sizeof(int32_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
    mPos += 4;
}

References CAST_SIZE, CAST_U32, DEBUGLOG2, expand(), mData, mPos, and toStringPrint().

Referenced by writeBeingId(), and writeItemId().

writeInt64()

void Net::MessageOut::writeInt64	(	const int64_t	value,
		const char *const	str
	)

Definition at line 113 of file messageout.cpp.

{
    DEBUGLOG2("writeInt64: " + toStringPrint(CAST_U32(value)),
        mPos, str);
    expand(8);
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
    int32_t swap = SDL_Swap64(value);
    memcpy(mData + CAST_SIZE(mPos), &swap, sizeof(int64_t));
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
    memcpy(mData + CAST_SIZE(mPos), &value, sizeof(int64_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
    mPos += 8;
}

References CAST_SIZE, CAST_U32, DEBUGLOG2, expand(), mData, mPos, and toStringPrint().

writeInt8()

void Net::MessageOut::writeInt8 ( const int8_t  value, const char *const  str  )

virtual

< Writes a byte. Writes a short.

Definition at line 61 of file messageout.cpp.

{
    expand(1);
    mData[mPos] = value;
    DEBUGLOG2("writeInt8:  " + toStringPrint(CAST_U32(
        CAST_U8(value))),
        mPos, str);
    mPos += 1;
}

References CAST_U32, CAST_U8, DEBUGLOG2, expand(), mData, mPos, and toStringPrint().

writeItemId()

void Net::MessageOut::writeItemId	(	const int32_t	value,
		const char *const	str
	)

Definition at line 104 of file messageout.cpp.

{
    if (itemIdLen == 2)
        writeInt16(CAST_S16(value), str);
    else
        writeInt32(value, str);
}

References CAST_S16, itemIdLen, writeInt16(), and writeInt32().

writeString()

void Net::MessageOut::writeString	(	const std::string &	string,
		int	length,
		const char *const	str
	)

Writes a string. If a fixed length is not given (-1), it is stored as a short at the start of the string.

Definition at line 177 of file messageout.cpp.

{
    int stringLength = CAST_S32(string.length());
    if (length < 0)
    {
        // Write the length at the start if not fixed
        writeInt16(CAST_S16(stringLength), "len");
        length = stringLength;
    }
    else if (length < stringLength)
    {
        // Make sure the length of the string is no longer than specified
        stringLength = length;
    }
    expand(length);
 
    // Write the actual string
    memcpy(mData + CAST_SIZE(mPos), string.c_str(), stringLength);
 
    // Pad remaining space with zeros
    if (length > stringLength)
    {
        memset(mData + CAST_SIZE(mPos + stringLength),
            '\0',
            length - stringLength);
    }
 
    DEBUGLOG2("writeString: " + string, mPos, str);
    mPos += length;
}

References CAST_S16, CAST_S32, CAST_SIZE, DEBUGLOG2, expand(), mData, mPos, and writeInt16().

writeStringNoLog()

void Net::MessageOut::writeStringNoLog	(	const std::string &	string,
		int	length,
		const char *const	str
	)

Writes a string. If a fixed length is not given (-1), it is stored as a short at the start of the string.

Definition at line 210 of file messageout.cpp.

{
    int stringLength = CAST_S32(string.length());
    if (length < 0)
    {
        // Write the length at the start if not fixed
        writeInt16(CAST_S16(stringLength), "len");
        length = stringLength;
    }
    else if (length < stringLength)
    {
        // Make sure the length of the string is no longer than specified
        stringLength = length;
    }
    expand(length);
 
    // Write the actual string
    memcpy(mData + CAST_SIZE(mPos), string.c_str(), stringLength);
 
    // Pad remaining space with zeros
    if (length > stringLength)
    {
        memset(mData + CAST_SIZE(mPos + stringLength),
            '\0',
            length - stringLength);
    }
 
    DEBUGLOG2("writeString: ***", mPos, str);
    mPos += length;
}

References CAST_S16, CAST_S32, CAST_SIZE, DEBUGLOG2, expand(), mData, mPos, and writeInt16().

Field Documentation

mData

char* Net::MessageOut::mData

protected

Data building up.

Definition at line 132 of file messageout.h.

Referenced by getData(), EAthena::MessageOut::MessageOut(), TmwAthena::MessageOut::MessageOut(), writeCoordinates(), writeFloat(), writeInt16(), writeInt32(), writeInt64(), writeInt8(), writeString(), and writeStringNoLog().

mDataSize

unsigned int Net::MessageOut::mDataSize

protected

Size of data.

Definition at line 133 of file messageout.h.

Referenced by getDataSize().

mId

uint16_t Net::MessageOut::mId

protected

Definition at line 135 of file messageout.h.

mIgnore

bool Net::MessageOut::mIgnore

protected

Definition at line 136 of file messageout.h.

mPos

unsigned int Net::MessageOut::mPos

protected

Position in the data.

Definition at line 134 of file messageout.h.

Referenced by resetPos(), writeCoordinates(), writeFloat(), writeInt16(), writeInt32(), writeInt64(), writeInt8(), writeString(), writeStringNoLog(), EAthena::MessageOut::~MessageOut(), and TmwAthena::MessageOut::~MessageOut().

---

The documentation for this class was generated from the following files:

• src/net/messageout.h (986a3bf)
• src/net/messageout.cpp (986a3bf)