Documentation of SFML 2.0

UdpSocket.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_UDPSOCKET_HPP
26 #define SFML_UDPSOCKET_HPP
27 
29 // Headers
31 #include <SFML/Network/Export.hpp>
32 #include <SFML/Network/Socket.hpp>
33 #include <vector>
34 
35 
36 namespace sf
37 {
38 class IpAddress;
39 class Packet;
40 
45 class SFML_NETWORK_API UdpSocket : public Socket
46 {
47 public :
48 
50  // Constants
52  enum
53  {
54  MaxDatagramSize = 65507
55  };
56 
61  UdpSocket();
62 
74  unsigned short getLocalPort() const;
75 
92  Status bind(unsigned short port);
93 
104  void unbind();
105 
123  Status send(const void* data, std::size_t size, const IpAddress& remoteAddress, unsigned short remotePort);
124 
146  Status receive(void* data, std::size_t size, std::size_t& received, IpAddress& remoteAddress, unsigned short& remotePort);
147 
164  Status send(Packet& packet, const IpAddress& remoteAddress, unsigned short remotePort);
165 
181  Status receive(Packet& packet, IpAddress& remoteAddress, unsigned short& remotePort);
182 
183 private:
184 
186  // Member data
188  std::vector<char> m_buffer;
189 };
190 
191 } // namespace sf
192 
193 
194 #endif // SFML_UDPSOCKET_HPP
195 
196