Net::MessageIn Class Reference

#include <messagein.h>

Inheritance diagram for Net::MessageIn:

Public Member Functions
virtual	~MessageIn ()
uint16_t	readId () const
int	getId () const
unsigned int	getLength () const
unsigned int	getUnreadLength () const
unsigned char	readUInt8 (const char *const str)
signed char	readInt8 (const char *const str)
int16_t	readInt16 (const char *const str)
uint16_t	readUInt16 (const char *const str)
int32_t	readInt32 (const char *const str)
uint32_t	readUInt32 (const char *const str)
int	readItemId (const char *const str)
int64_t	readInt64 (const char *const str)
BeingId	readBeingId (const char *const str)
float	readFloat (const char *const str)
void	readCoordinates (uint16_t &x, uint16_t &y, uint8_t &direction, const char *const str)
void	readCoordinatePair (uint16_t &srcX, uint16_t &srcY, uint16_t &dstX, uint16_t &dstY, const char *const str)
void	skip (const unsigned int length, const char *const str)
void	skipToEnd (const char *const str)
std::string	readString (int length, const char *const dstr)
std::string	readRawString (int length, const char *const dstr)
unsigned char *	readBytes (int length, const char *const dstr)
int	getVersion () const
int	getVersionMain () const
int	getVersionRe () const
int	getVersionZero () const

Static Public Member Functions
static uint8_t	fromServerDirection (const uint8_t serverDir)

Protected Member Functions
	MessageIn (const char *const data, const unsigned int length)

Protected Attributes
const char *	mData
unsigned int	mLength
unsigned int	mPos
int	mVersion
uint16_t	mId
bool	mIgnore

Detailed Description

Used for parsing an incoming message.

Definition at line 41 of file messagein.h.

Constructor & Destructor Documentation

~MessageIn()

Net::MessageIn::~MessageIn ( )

virtual

Definition at line 66 of file messagein.cpp.

{
    if (mLength != 0U)
    {
        if (mPos != mLength && mPos != 2)
        {
            logger->log("Wrong actual or planned inbound packet size!");
            logger->log(" packet id: %u 0x%x",
                CAST_U32(mId),
                CAST_U32(mId));
            logger->log(" planned size: %u", mLength);
            logger->log(" read size: %u", mPos);
            WRONGPACKETSIZE;
        }
    }
    else
    {
        logger->log("Zero packet size: %d", CAST_S32(mId));
    }
}

References CAST_S32, CAST_U32, Logger::log(), logger, mId, mLength, mPos, and WRONGPACKETSIZE.

MessageIn()

Net::MessageIn::MessageIn ( const char *const  data, const unsigned int  length  )

protected

Constructor.

Definition at line 54 of file messagein.cpp.

                                                :
    mData(data),
    mLength(length),
    mPos(0),
    mVersion(0),
    mId(0),
    mIgnore(false)
{
    PacketCounters::incInPackets();
}

References PacketCounters::incInPackets().

Member Function Documentation

fromServerDirection()

uint8_t Net::MessageIn::fromServerDirection ( const uint8_t  serverDir )

static

Definition at line 266 of file messagein.cpp.

{
    // Translate from eAthena format
    switch (serverDir)
    {
        case 0:
            return 1;
        case 1:
            return 3;
        case 2:
            return 2;
        case 3:
            return 6;
        case 4:
            return 4;
        case 5:
            return 12;
        case 6:
            return 8;
        case 7:
            return 9;
        case 8:
            return 8;
        default:
            logger->log("incorrect direction: %d",
                CAST_S32(serverDir));
            return 0;
    }
}

References CAST_S32, Logger::log(), and logger.

Referenced by EAthena::BeingRecv::processBeingChangeDirection(), TmwAthena::BeingRecv::processBeingChangeDirection(), Ea::NpcRecv::processNpcCommand(), and readCoordinates().

getId()

int Net::MessageIn::getId ( ) const

inline

Returns the message ID.

Definition at line 53 of file messagein.h.

        { return mId; }

References mId.

getLength()

unsigned int Net::MessageIn::getLength ( ) const

inline

Returns the message length.

Definition at line 59 of file messagein.h.

        { return mLength; }

References mLength.

getUnreadLength()

unsigned int Net::MessageIn::getUnreadLength ( ) const

inline

Returns the length of unread data. Reads a byte.

Definition at line 65 of file messagein.h.

References mLength, and mPos.

getVersion()

int Net::MessageIn::getVersion ( ) const

inline

Definition at line 136 of file messagein.h.

        { return mVersion; }

References mVersion.

getVersionMain()

int Net::MessageIn::getVersionMain

(

)

const

Definition at line 500 of file messagein.cpp.

{
    if (packetVersionMain >= mVersion)
        return mVersion;
    return 0;
}

References mVersion, and packetVersionMain.

getVersionRe()

int Net::MessageIn::getVersionRe

(

)

const

Definition at line 507 of file messagein.cpp.

{
    if (packetVersionRe >= mVersion)
        return mVersion;
    return 0;
}

References mVersion, and packetVersionRe.

getVersionZero()

int Net::MessageIn::getVersionZero

(

)

const

Definition at line 514 of file messagein.cpp.

{
    if (packetVersionZero >= mVersion)
        return mVersion;
    return 0;
}

References mVersion, and packetVersionZero.

readBeingId()

BeingId Net::MessageIn::readBeingId

(

const char *const

str

)

Definition at line 224 of file messagein.cpp.

{
    return fromInt(readUInt32(str), BeingId);
}

References fromInt, and readUInt32().

readBytes()

unsigned char * Net::MessageIn::readBytes	(	int	length,
		const char *const	dstr
	)

Definition at line 454 of file messagein.cpp.

{
    // Get string length
    if (length < 0)
        length = readInt16("len");
 
    // Make sure the string isn't erroneous
    if (length < 0 || mPos + length > mLength)
    {
        DEBUGLOG2("readBytesString error", mPos, dstr);
        mPos = mLength + 1;
        return nullptr;
    }
 
    unsigned char *const buf
        = new unsigned char[CAST_SIZE(length + 2)];
 
    memcpy(buf, mData + CAST_SIZE(mPos), length);
    buf[length] = 0;
    buf[length + 1] = 0;
    mPos += length;
 
#ifdef ENABLEDEBUGLOG
    if (!mIgnore)
    {
        std::string str;
        for (int f = 0; f < length; f ++)
            str.append(strprintf("%02x", CAST_U32(buf[f])));
        str += " ";
        for (int f = 0; f < length; f ++)
        {
            if (buf[f] != 0U)
                str.append(strprintf("%c", buf[f]));
            else
                str.append("_");
        }
        if (dstr != nullptr)
            logger->dlog(dstr);
        logger->dlog("ReadBytes: " + str);
    }
#endif  // ENABLEDEBUGLOG
 
    PacketCounters::incInBytes(length);
    return buf;
}

References CAST_SIZE, CAST_U32, DEBUGLOG2, Logger::dlog(), PacketCounters::incInBytes(), logger, mData, mIgnore, mLength, mPos, readInt16(), and strprintf().

readCoordinatePair()

void Net::MessageIn::readCoordinatePair	(	uint16_t &	srcX,
		uint16_t &	srcY,
		uint16_t &	dstX,
		uint16_t &	dstY,
		const char *const	str
	)

Reads a special 5 byte block used by eAthena, containing a source and destination coordinate pair.

Definition at line 328 of file messagein.cpp.

{
    if (mPos + 5 <= mLength)
    {
        const char *const data = mData + CAST_SIZE(mPos);
        uint16_t temp = MAKEWORD(data[3], data[2] & 0x000f);
        dstX = CAST_U16(temp >> 2);
 
        dstY = MAKEWORD(data[4], data[3] & 0x0003);
 
        temp = MAKEWORD(data[1], data[0]);
        srcX = CAST_U16(temp >> 6);
 
        temp = MAKEWORD(data[2], data[1] & 0x003f);
        srcY = CAST_U16(temp >> 4);
 
        DEBUGLOG2(std::string("readCoordinatePair: ").append(toString(
            CAST_S32(srcX))).append(",").append(toString(
            CAST_S32(srcY))).append(" ").append(toString(
            CAST_S32(dstX))).append(",").append(toString(
            CAST_S32(dstY))), mPos, str);
    }
    else
    {
        srcX = 0;
        srcY = 0;
        dstX = 0;
        dstY = 0;
        logger->log("error: wrong readCoordinatePair packet");
    }
    mPos += 5;
    PacketCounters::incInBytes(5);
}

References CAST_S32, CAST_SIZE, CAST_U16, data, DEBUGLOG2, PacketCounters::incInBytes(), Logger::log(), logger, MAKEWORD, mData, mLength, mPos, and Catch::toString().

readCoordinates()

void Net::MessageIn::readCoordinates	(	uint16_t &	x,
		uint16_t &	y,
		uint8_t &	direction,
		const char *const	str
	)

Reads a special 3 byte block used by eAthena, containing x and y coordinates and direction.

Definition at line 296 of file messagein.cpp.

{
    if (mPos + 3 <= mLength)
    {
        const char *const data = mData + CAST_SIZE(mPos);
        uint16_t temp = MAKEWORD(data[1] & 0x00c0, data[0] & 0x00ff);
        x = CAST_U16(temp >> 6);
        temp = MAKEWORD(data[2] & 0x00f0, data[1] & 0x003f);
        y = CAST_U16(temp >> 4);
 
        const uint8_t serverDir = CAST_U8(data[2] & 0x000f);
        direction = fromServerDirection(serverDir);
 
        DEBUGLOG2(std::string("readCoordinates: ").append(toString(
            CAST_S32(x))).append(",").append(toString(
            CAST_S32(y))).append(",").append(toString(
            CAST_S32(serverDir))), mPos, str);
    }
    else
    {
        x = 0;
        y = 0;
        direction = 0;
        logger->log("error: wrong readCoordinates packet");
    }
    mPos += 3;
    PacketCounters::incInBytes(3);
}

References CAST_S32, CAST_SIZE, CAST_U16, CAST_U8, data, DEBUGLOG2, fromServerDirection(), PacketCounters::incInBytes(), Logger::log(), logger, MAKEWORD, mData, mLength, mPos, Catch::toString(), x, and y.

readFloat()

float Net::MessageIn::readFloat

(

const char *const

str

)

Definition at line 250 of file messagein.cpp.

{
    float value = 0;
    if (mPos + 4 <= mLength)
    {
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(float));
    }
#ifdef ENABLEDEBUGLOG
    std::string text = strprintf("readFloat: %f", value);
    DEBUGLOG2(str, mPos, text.c_str());
#endif
    mPos += 4;
    PacketCounters::incInBytes(4);
    return value;
}

References CAST_SIZE, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and strprintf().

readId()

uint16_t Net::MessageIn::readId

(

)

const

Definition at line 87 of file messagein.cpp.

{
    int16_t value = -1;
    if (mPos + 2 <= mLength)
    {
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
        int16_t swap;
        memcpy(&swap, mData + CAST_SIZE(mPos), sizeof(int16_t));
        value = SDL_Swap16(swap);
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(int16_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
    }
    return value;
}

References CAST_SIZE, mData, mLength, and mPos.

Referenced by TmwAthena::MessageIn::postInit(), and EAthena::MessageIn::postInit().

readInt16()

int16_t Net::MessageIn::readInt16

(

const char *const

str

)

Definition at line 131 of file messagein.cpp.

{
    int16_t value = -1;
    if (mPos + 2 <= mLength)
    {
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
        int16_t swap;
        memcpy(&swap, mData + CAST_SIZE(mPos), sizeof(int16_t));
        value = SDL_Swap16(swap);
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(int16_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
    }
    DEBUGLOG2("readInt16:  " + toStringPrint(CAST_U32(
        CAST_U16(value))),
        mPos, str);
    mPos += 2;
    PacketCounters::incInBytes(2);
    return value;
}

References CAST_SIZE, CAST_U16, CAST_U32, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

Referenced by TmwAthena::MessageIn::postInit(), EAthena::MessageIn::postInit(), readBytes(), readItemId(), readRawString(), and readString().

readInt32()

int32_t Net::MessageIn::readInt32

(

const char *const

str

)

Definition at line 175 of file messagein.cpp.

{
    int32_t value = -1;
    if (mPos + 4 <= mLength)
    {
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
        int32_t swap;
        memcpy(&swap, mData + CAST_SIZE(mPos), sizeof(int32_t));
        value = SDL_Swap32(swap);
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(int32_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
    }
    DEBUGLOG2("readInt32:  " + toStringPrint(CAST_S32(value)),
        mPos, str);
    mPos += 4;
    PacketCounters::incInBytes(4);
    return value;
}

References CAST_S32, CAST_SIZE, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

Referenced by readItemId().

readInt64()

int64_t Net::MessageIn::readInt64

(

const char *const

str

)

Definition at line 229 of file messagein.cpp.

{
    int64_t value = -1;
    if (mPos + 8 <= mLength)
    {
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
        int64_t swap;
        memcpy(&swap, mData + CAST_SIZE(mPos), sizeof(int64_t));
        value = SDL_Swap64(swap);
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(int64_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
    }
    DEBUGLOG2("readInt64:  " + toStringPrint(CAST_U32(value)),
        mPos, str);
    mPos += 8;
    PacketCounters::incInBytes(8);
    return value;
}

References CAST_SIZE, CAST_U32, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

readInt8()

signed char Net::MessageIn::readInt8

(

const char *const

str

)

Reads a short.

Definition at line 117 of file messagein.cpp.

{
    signed char value = CAST_S8(-1);
    if (mPos < mLength)
        value = CAST_S8(mData[mPos]);
 
    DEBUGLOG2("readInt8:   " + toStringPrint(CAST_U32(
        CAST_U8(value))),
        mPos, str);
    mPos += 1;
    PacketCounters::incInBytes(1);
    return value;
}

References CAST_S8, CAST_U32, CAST_U8, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

readItemId()

int Net::MessageIn::readItemId

(

const char *const

str

)

Definition at line 217 of file messagein.cpp.

{
    if (itemIdLen == 2)
        return readInt16(str);
    return readInt32(str);
}

References itemIdLen, readInt16(), and readInt32().

readRawString()

std::string Net::MessageIn::readRawString	(	int	length,
		const char *const	dstr
	)

Definition at line 411 of file messagein.cpp.

{
    // Get string length
    if (length < 0)
        length = readInt16("len");
 
    // Make sure the string isn't erroneous
    if (length < 0 || mPos + length > mLength)
    {
        mPos = mLength + 1;
        return "";
    }
 
    // Read the string
    const char *const stringBeg = mData + CAST_SIZE(mPos);
    const char *const stringEnd
        = static_cast<const char *>(memchr(stringBeg, '\0', length));
    std::string str(stringBeg, stringEnd != nullptr
        ? stringEnd - stringBeg : CAST_SIZE(length));
 
    DEBUGLOG2("readString: " + str, mPos, dstr);
 
    if (stringEnd != nullptr)
    {
        const size_t len2 = CAST_SIZE(length)
            - (stringEnd - stringBeg) - 1;
        const char *const stringBeg2 = stringEnd + 1;
        const char *const stringEnd2
            = static_cast<const char *>(memchr(stringBeg2, '\0', len2));
        const std::string hiddenPart = std::string(stringBeg2,
            stringEnd2 != nullptr ? stringEnd2 - stringBeg2 : len2);
        if (hiddenPart.length() > 0)
        {
            DEBUGLOG2("readString2: " + hiddenPart, mPos, dstr);
            return str.append("|").append(hiddenPart);
        }
    }
    mPos += length;
    PacketCounters::incInBytes(length);
 
    return str;
}

References CAST_SIZE, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and readInt16().

readString()

std::string Net::MessageIn::readString	(	int	length,
		const char *const	dstr
	)

Reads a string. If a length is not given (-1), it is assumed that the length of the string is stored in a short at the start of the string.

Definition at line 384 of file messagein.cpp.

{
    // Get string length
    if (length < 0)
        length = readInt16("len");
 
    // Make sure the string isn't erroneous
    if (length < 0 || mPos + length > mLength)
    {
        DEBUGLOG2("readString error", mPos, dstr);
        mPos = mLength + 1;
        return "";
    }
 
    // Read the string
    const char *const stringBeg = mData + CAST_SIZE(mPos);
    const char *const stringEnd
        = static_cast<const char *>(memchr(stringBeg, '\0', length));
 
    const std::string str(stringBeg, stringEnd != nullptr
        ? stringEnd - stringBeg : CAST_SIZE(length));
    DEBUGLOG2("readString: " + str, mPos, dstr);
    mPos += length;
    PacketCounters::incInBytes(length);
    return str;
}

References CAST_SIZE, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and readInt16().

readUInt16()

uint16_t Net::MessageIn::readUInt16

(

const char *const

str

)

Reads a long.

Definition at line 153 of file messagein.cpp.

{
    uint16_t value = 0xffU;
    if (mPos + 2 <= mLength)
    {
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
        uint16_t swap;
        memcpy(&swap, mData + CAST_SIZE(mPos), sizeof(uint16_t));
        value = SDL_Swap16(swap);
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(uint16_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
    }
    DEBUGLOG2("readUInt16:  " + toStringPrint(CAST_U32(
        CAST_U16(value))),
        mPos, str);
    mPos += 2;
    PacketCounters::incInBytes(2);
    return value;
}

References CAST_SIZE, CAST_U16, CAST_U32, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

readUInt32()

uint32_t Net::MessageIn::readUInt32

(

const char *const

str

)

Definition at line 196 of file messagein.cpp.

{
    uint32_t value = 0;
    if (mPos + 4 <= mLength)
    {
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
        uint32_t swap;
        memcpy(&swap, mData + CAST_SIZE(mPos), sizeof(int32_t));
        value = SDL_Swap32(swap);
#else  // SDL_BYTEORDER == SDL_BIG_ENDIAN
 
        memcpy(&value, mData + CAST_SIZE(mPos), sizeof(int32_t));
#endif  // SDL_BYTEORDER == SDL_BIG_ENDIAN
    }
    DEBUGLOG2("readInt32:  " + toStringPrint(CAST_U32(value)),
        mPos, str);
    mPos += 4;
    PacketCounters::incInBytes(4);
    return value;
}

References CAST_SIZE, CAST_U32, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

Referenced by readBeingId().

readUInt8()

unsigned char Net::MessageIn::readUInt8

(

const char *const

str

)

Reads a byte.

Definition at line 104 of file messagein.cpp.

{
    unsigned char value = CAST_U8(-1);
    if (mPos < mLength)
        value = CAST_U8(mData[mPos]);
 
    DEBUGLOG2("readUInt8:  " + toStringPrint(CAST_U32(value)),
        mPos, str);
    mPos += 1;
    PacketCounters::incInBytes(1);
    return value;
}

References CAST_U32, CAST_U8, DEBUGLOG2, PacketCounters::incInBytes(), mData, mLength, mPos, and toStringPrint().

skip()

void Net::MessageIn::skip	(	const unsigned int	length,
		const char *const	str
	)

Skips a given number of bytes.

Definition at line 366 of file messagein.cpp.

{
    DEBUGLOG2("skip: " + toString(CAST_S32(length)), mPos, str);
    mPos += length;
    PacketCounters::incInBytes(length);
}

References CAST_S32, DEBUGLOG2, PacketCounters::incInBytes(), mPos, and Catch::toString().

skipToEnd()

void Net::MessageIn::skipToEnd

(

const char *const

str

)

Definition at line 373 of file messagein.cpp.

{
    const int diff = CAST_S32(mLength - mPos);
    if (diff != 0)
    {
        DEBUGLOG2("skip: " + toString(diff), mPos, str);
        mPos = mLength;
        PacketCounters::incInBytes(diff);
    }
}

References CAST_S32, DEBUGLOG2, PacketCounters::incInBytes(), mLength, mPos, and Catch::toString().

Field Documentation

mData

const char* Net::MessageIn::mData

protected

The message data.

Definition at line 151 of file messagein.h.

Referenced by readBytes(), readCoordinatePair(), readCoordinates(), readFloat(), readId(), readInt16(), readInt32(), readInt64(), readInt8(), readRawString(), readString(), readUInt16(), readUInt32(), and readUInt8().

mId

uint16_t Net::MessageIn::mId

protected

The message ID.

Definition at line 161 of file messagein.h.

Referenced by getId(), TmwAthena::MessageIn::postInit(), EAthena::MessageIn::postInit(), and ~MessageIn().

mIgnore

bool Net::MessageIn::mIgnore

protected

Definition at line 162 of file messagein.h.

Referenced by readBytes().

mLength

unsigned int Net::MessageIn::mLength

protected

The length of the data.

Definition at line 152 of file messagein.h.

Referenced by getLength(), getUnreadLength(), readBytes(), readCoordinatePair(), readCoordinates(), readFloat(), readId(), readInt16(), readInt32(), readInt64(), readInt8(), readRawString(), readString(), readUInt16(), readUInt32(), readUInt8(), skipToEnd(), and ~MessageIn().

mPos

unsigned int Net::MessageIn::mPos

protected

Actual position in the packet. From 0 to packet->length. A value bigger than packet->length means EOP was reached when reading it.

Definition at line 159 of file messagein.h.

Referenced by getUnreadLength(), readBytes(), readCoordinatePair(), readCoordinates(), readFloat(), readId(), readInt16(), readInt32(), readInt64(), readInt8(), readRawString(), readString(), readUInt16(), readUInt32(), readUInt8(), skip(), skipToEnd(), and ~MessageIn().

mVersion

int Net::MessageIn::mVersion

protected

Definition at line 160 of file messagein.h.

Referenced by getVersion(), getVersionMain(), getVersionRe(), getVersionZero(), and EAthena::MessageIn::postInit().

---

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

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