1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* The Mana Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
*
* This file is part of The Mana Client.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef NET_MESSAGEIN_H
#define NET_MESSAGEIN_H
#include <cstdint>
#include <string>
namespace Net {
/**
* Used for parsing an incoming message.
*
* \ingroup Network
*/
class MessageIn
{
public:
/**
* Returns the message ID.
*/
uint16_t getId() const { return mId; }
/**
* Returns the message length.
*/
unsigned int getLength() const { return mLength; }
/**
* Returns the length of unread data.
*/
unsigned int getUnreadLength() const { return mLength - mPos; }
/**
* Reads an unsigned 8-bit integer from the message.
*/
virtual uint8_t readInt8();
/**
* Reads an unsigned 16-bit integer from the message.
*/
virtual uint16_t readInt16() = 0;
/**
* Reads an unsigned 32-bit integer from the message.
*/
virtual uint32_t readInt32() = 0;
/**
* Reads a 3-byte block containing tile-based coordinates. Used by
* manaserv.
*/
virtual void readCoordinates(uint16_t &x, uint16_t &y);
/**
* Reads a special 3 byte block used by eAthena, containing x and y
* coordinates and direction.
*/
virtual void readCoordinates(uint16_t &x, uint16_t &y, uint8_t &direction);
/**
* Reads a special 5 byte block used by eAthena, containing a source
* and destination coordinate pair.
*/
virtual void readCoordinatePair(uint16_t &srcX, uint16_t &srcY,
uint16_t &dstX, uint16_t &dstY);
/**
* Skips a given number of bytes.
*/
virtual void skip(unsigned int length);
/**
* 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.
*/
virtual std::string readString(int length = -1);
virtual ~MessageIn() {}
protected:
MessageIn(const char *data, unsigned int length);
const char *mData; /**< The message data. */
unsigned int mLength; /**< The length of the data. */
unsigned short mId; /**< The message ID. */
/**
* Actual position in the packet. From 0 to packet->length.
* A value bigger than packet->length means EOP was reached when
* reading it.
*/
unsigned int mPos;
};
} // namespace Net
#endif // NET_MESSAGEIN_H
|
