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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2014 The ManaPlus Developers
*
* This file is part of The ManaPlus 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 <string>
#include "localconsts.h"
namespace Net
{
/**
* Used for parsing an incoming message.
*
* \ingroup Network
*/
class MessageIn notfinal
{
public:
A_DELETE_COPY(MessageIn)
/**
* Returns the message ID.
*/
int getId() const A_WARN_UNUSED
{ return mId; }
/**
* Returns the message length.
*/
unsigned int getLength() const A_WARN_UNUSED
{ return mLength; }
/**
* Returns the length of unread data.
*/
unsigned int getUnreadLength() const A_WARN_UNUSED
{ return mLength > mPos ? mLength - mPos : 0; }
/**< Reads a byte. */
virtual unsigned char readUInt8(const char *const str = nullptr);
/**< Reads a byte. */
virtual signed char readInt8(const char *const str = nullptr);
/**< Reads a short. */
virtual int16_t readInt16(const char *const str = nullptr) = 0;
/**< Reads a long. */
virtual int readInt32(const char *const str = nullptr) = 0;
/**
* Reads a special 3 byte block used by eAthena, containing x and y
* coordinates and direction.
*/
virtual void readCoordinates(uint16_t &restrict x,
uint16_t &restrict y,
uint8_t &restrict direction,
const char *const str = nullptr);
/**
* Reads a special 5 byte block used by eAthena, containing a source
* and destination coordinate pair.
*/
virtual void readCoordinatePair(uint16_t &restrict srcX,
uint16_t &restrict srcY,
uint16_t &restrict dstX,
uint16_t &restrict dstY,
const char *const str = nullptr);
/**
* Skips a given number of bytes.
*/
virtual void skip(const unsigned int length,
const char *const str = nullptr);
/**
* 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,
const char *const dstr = nullptr);
virtual std::string readRawString(int length,
const char *const dstr = nullptr);
unsigned char *readBytes(int length,
const char *const dstr = nullptr);
virtual ~MessageIn()
{ }
static uint8_t fromServerDirection(const uint8_t serverDir)
A_WARN_UNUSED;
protected:
/**
* Constructor.
*/
MessageIn(const char *const data, const unsigned int length);
const char *mData; /**< The message data. */
unsigned int mLength; /**< The length of the data. */
uint16_t 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
|
