Documentation of SFML 2.0

Packet.hpp
1 
2 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_PACKET_HPP
26 #define SFML_PACKET_HPP
27 
29 // Headers
31 #include <SFML/Network/Export.hpp>
32 #include <string>
33 #include <vector>
34 
35 
36 namespace sf
37 {
38 class String;
39 class TcpSocket;
40 class UdpSocket;
41 
47 class SFML_NETWORK_API Packet
48 {
49  // A bool-like type that cannot be converted to integer or pointer types
50  typedef bool (Packet::*BoolType)(std::size_t);
51 
52 public :
53 
60  Packet();
61 
66  virtual ~Packet();
67 
77  void append(const void* data, std::size_t sizeInBytes);
78 
87  void clear();
88 
102  const void* getData() const;
103 
115  std::size_t getDataSize() const;
116 
129  bool endOfPacket() const;
130 
131 public:
132 
171  operator BoolType() const;
172 
177  Packet& operator >>(bool& data);
178  Packet& operator >>(Int8& data);
179  Packet& operator >>(Uint8& data);
180  Packet& operator >>(Int16& data);
181  Packet& operator >>(Uint16& data);
182  Packet& operator >>(Int32& data);
183  Packet& operator >>(Uint32& data);
184  Packet& operator >>(float& data);
185  Packet& operator >>(double& data);
186  Packet& operator >>(char* data);
187  Packet& operator >>(std::string& data);
188  Packet& operator >>(wchar_t* data);
189  Packet& operator >>(std::wstring& data);
190  Packet& operator >>(String& data);
191 
196  Packet& operator <<(bool data);
197  Packet& operator <<(Int8 data);
198  Packet& operator <<(Uint8 data);
199  Packet& operator <<(Int16 data);
200  Packet& operator <<(Uint16 data);
201  Packet& operator <<(Int32 data);
202  Packet& operator <<(Uint32 data);
203  Packet& operator <<(float data);
204  Packet& operator <<(double data);
205  Packet& operator <<(const char* data);
206  Packet& operator <<(const std::string& data);
207  Packet& operator <<(const wchar_t* data);
208  Packet& operator <<(const std::wstring& data);
209  Packet& operator <<(const String& data);
210 
211 protected:
212 
213  friend class TcpSocket;
214  friend class UdpSocket;
215 
234  virtual const void* onSend(std::size_t& size);
235 
253  virtual void onReceive(const void* data, std::size_t size);
254 
255 private :
256 
261  bool operator ==(const Packet& right) const;
262  bool operator !=(const Packet& right) const;
263 
274  bool checkSize(std::size_t size);
275 
277  // Member data
279  std::vector<char> m_data;
280  std::size_t m_readPos;
281  bool m_isValid;
282 };
283 
284 } // namespace sf
285 
286 
287 #endif // SFML_PACKET_HPP
288 
289