ManaPlus
messagein.h
Go to the documentation of this file.
1 /*
2  * The ManaPlus Client
3  * Copyright (C) 2004-2009 The Mana World Development Team
4  * Copyright (C) 2009-2010 The Mana Developers
5  * Copyright (C) 2011-2018 The ManaPlus Developers
6  *
7  * This file is part of The ManaPlus Client.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <http://www.gnu.org/licenses/>.
21  */
22 
23 #ifndef NET_MESSAGEIN_H
24 #define NET_MESSAGEIN_H
25 
27 
28 #include <string>
29 
30 #include "localconsts.h"
31 
32 namespace Net
33 {
34 
41 {
42  public:
44 
45  virtual ~MessageIn();
46 
47  uint16_t readId() const;
48 
53  { return mId; }
54 
58  unsigned int getLength() const noexcept2 A_WARN_UNUSED
59  { return mLength; }
60 
65  { return mLength > mPos ? mLength - mPos : 0; }
66 
68  unsigned char readUInt8(const char *const str);
69 
71  signed char readInt8(const char *const str);
72 
74  int16_t readInt16(const char *const str);
75 
76  uint16_t readUInt16(const char *const str);
77 
79  int32_t readInt32(const char *const str);
80 
81  uint32_t readUInt32(const char *const str);
82 
83  int64_t readInt64(const char *const str);
84 
85  BeingId readBeingId(const char *const str);
86 
91  void readCoordinates(uint16_t &restrict x,
92  uint16_t &restrict y,
93  uint8_t &restrict direction,
94  const char *const str);
95 
100  void readCoordinatePair(uint16_t &restrict srcX,
101  uint16_t &restrict srcY,
102  uint16_t &restrict dstX,
103  uint16_t &restrict dstY,
104  const char *const str);
105 
109  void skip(const unsigned int length,
110  const char *const str);
111 
112  void skipToEnd(const char *const str);
113 
119  std::string readString(int length,
120  const char *const dstr);
121 
122  std::string readRawString(int length,
123  const char *const dstr);
124 
125  unsigned char *readBytes(int length,
126  const char *const dstr);
127 
128  static uint8_t fromServerDirection(const uint8_t serverDir)
130 
131  unsigned int getVersion() const noexcept2 A_WARN_UNUSED
132  { return mVersion; }
133 
134  protected:
138  MessageIn(const char *const data, const unsigned int length);
139 
140  const char *mData;
141  unsigned int mLength;
148  unsigned int mPos;
149  unsigned int mVersion;
150  uint16_t mId;
151  bool mIgnore;
152 };
153 
154 } // namespace Net
155 
156 #endif // NET_MESSAGEIN_H
#define A_DELETE_COPY(func)
Definition: localconsts.h:52
unsigned int mVersion
Definition: messagein.h:149
unsigned char readUInt8(const char *const str)
Definition: messagein.cpp:98
uint16_t readUInt16(const char *const str)
Definition: messagein.cpp:147
BeingId readBeingId(const char *const str)
Definition: messagein.cpp:211
uint16_t readId() const
Definition: messagein.cpp:81
virtual ~MessageIn()
Definition: messagein.cpp:60
#define A_WARN_UNUSED
Definition: localconsts.h:152
unsigned int getLength() const
Definition: messagein.h:58
int BeingId
Definition: beingid.h:29
unsigned int getUnreadLength() const
Definition: messagein.h:64
uint16_t mId
Definition: messagein.h:150
uint32_t readUInt32(const char *const str)
Definition: messagein.cpp:190
void readCoordinates(uint16_t &x, uint16_t &y, uint8_t &direction, const char *const str)
Definition: messagein.cpp:267
signed char readInt8(const char *const str)
Definition: messagein.cpp:111
int getId() const
Definition: messagein.h:52
int64_t readInt64(const char *const str)
Definition: messagein.cpp:216
unsigned int mPos
Definition: messagein.h:148
int16_t readInt16(const char *const str)
Definition: messagein.cpp:125
void readCoordinatePair(uint16_t &srcX, uint16_t &srcY, uint16_t &dstX, uint16_t &dstY, const char *const str)
Definition: messagein.cpp:299
uint32_t data
MessageIn(const char *const data, const unsigned int length)
Definition: messagein.cpp:48
std::string readRawString(int length, const char *const dstr)
Definition: messagein.cpp:382
void skip(const unsigned int length, const char *const str)
Definition: messagein.cpp:337
const char * mData
Definition: messagein.h:140
#define notfinal
Definition: localconsts.h:252
unsigned int getVersion() const
Definition: messagein.h:131
void skipToEnd(const char *const str)
Definition: messagein.cpp:344
#define restrict
Definition: localconsts.h:156
std::string readString(int length, const char *const dstr)
Definition: messagein.cpp:355
static uint8_t fromServerDirection(const uint8_t serverDir)
Definition: messagein.cpp:237
unsigned int mLength
Definition: messagein.h:141
int32_t readInt32(const char *const str)
Definition: messagein.cpp:169
#define noexcept2
Definition: localconsts.h:49
unsigned char * readBytes(int length, const char *const dstr)
Definition: messagein.cpp:425