UdpSocket.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
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 CPP3DS_UDPSOCKET_HPP
26 #define CPP3DS_UDPSOCKET_HPP
27 
29 // Headers
31 #include <cpp3ds/Network/Socket.hpp>
32 #include <vector>
33 
34 
35 namespace cpp3ds
36 {
37 class IpAddress;
38 class Packet;
39 
44 class UdpSocket : public Socket
45 {
46 public:
47 
49  // Constants
51  enum
52  {
53  MaxDatagramSize = 65507
54  };
55 
60  UdpSocket();
61 
73  unsigned short getLocalPort() const;
74 
91  Status bind(unsigned short port);
92 
103  void unbind();
104 
122  Status send(const void* data, std::size_t size, const IpAddress& remoteAddress, unsigned short remotePort);
123 
145  Status receive(void* data, std::size_t size, std::size_t& received, IpAddress& remoteAddress, unsigned short& remotePort);
146 
163  Status send(Packet& packet, const IpAddress& remoteAddress, unsigned short remotePort);
164 
180  Status receive(Packet& packet, IpAddress& remoteAddress, unsigned short& remotePort);
181 
182 private:
183 
185  // Member data
187  std::vector<char> m_buffer;
188 };
189 
190 } // namespace cpp3ds
191 
192 
193 #endif // CPP3DS_UDPSOCKET_HPP
194 
195 
Encapsulate an IPv4 network address.
Definition: IpAddress.hpp:43
Specialized socket using the UDP protocol.
Definition: UdpSocket.hpp:44
Utility class to build blocks of data to transfer over the network.
Definition: Packet.hpp:47
Base class for all the socket types.
Definition: Socket.hpp:44
Status bind(unsigned short port)
Bind the socket to a specific port.
unsigned short getLocalPort() const
Get the port to which the socket is bound locally.
Status send(const void *data, std::size_t size, const IpAddress &remoteAddress, unsigned short remotePort)
Send raw data to a remote peer.
Status receive(void *data, std::size_t size, std::size_t &received, IpAddress &remoteAddress, unsigned short &remotePort)
Receive raw data from a remote peer.
void unbind()
Unbind the socket from the local port to which it is bound.
The maximum number of bytes that can be sent in a single UDP datagram.
Definition: UdpSocket.hpp:53
Status
Status codes that may be returned by socket functions.
Definition: Socket.hpp:52
UdpSocket()
Default constructor.