SFML - Simple and Fast Multimedia Library

SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

UdpSocket.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 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 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 <SFML/Network/IpAddress.hpp>
34#include <vector>
35
36
37namespace sf
38{
39class Packet;
40
45 class SFML_NETWORK_API UdpSocket : public Socket
46{
47public:
48
50 // Constants
52 enum
53 {
54 MaxDatagramSize = 65507
55 };
56
61 UdpSocket();
62
74 unsigned short getLocalPort() const;
75
98 Status bind(unsigned short port, const IpAddress& address = IpAddress::Any);
99
112 void unbind();
113
131 Status send(const void* data, std::size_t size, const IpAddress& remoteAddress, unsigned short remotePort);
132
154 Status receive(void* data, std::size_t size, std::size_t& received, IpAddress& remoteAddress, unsigned short& remotePort);
155
172 Status send(Packet& packet, const IpAddress& remoteAddress, unsigned short remotePort);
173
189 Status receive(Packet& packet, IpAddress& remoteAddress, unsigned short& remotePort);
190
191private:
192
194 // Member data
196 std::vector<char> m_buffer;
197};
198
199} // namespace sf
200
201
202#endif // SFML_UDPSOCKET_HPP
203
204
sf::IpAddress
Encapsulate an IPv4 network address.
Definition: IpAddress.hpp:45
sf::IpAddress::Any
static const IpAddress Any
Value representing any address (0.0.0.0)
Definition: IpAddress.hpp:185
sf::Packet
Utility class to build blocks of data to transfer over the network.
Definition: Packet.hpp:48
sf::Socket
Base class for all the socket types.
Definition: Socket.hpp:46
sf::Socket::Status
Status
Status codes that may be returned by socket functions.
Definition: Socket.hpp:54
sf::UdpSocket
Specialized socket using the UDP protocol.
Definition: UdpSocket.hpp:46
sf::UdpSocket::unbind
void unbind()
Unbind the socket from the local port to which it is bound.
sf::UdpSocket::send
Status send(Packet &packet, const IpAddress &remoteAddress, unsigned short remotePort)
Send a formatted packet of data to a remote peer.
sf::UdpSocket::getLocalPort
unsigned short getLocalPort() const
Get the port to which the socket is bound locally.
sf::UdpSocket::send
Status send(const void *data, std::size_t size, const IpAddress &remoteAddress, unsigned short remotePort)
Send raw data to a remote peer.
sf::UdpSocket::UdpSocket
UdpSocket()
Default constructor.
sf::UdpSocket::bind
Status bind(unsigned short port, const IpAddress &address=IpAddress::Any)
Bind the socket to a specific port.
sf::UdpSocket::receive
Status receive(void *data, std::size_t size, std::size_t &received, IpAddress &remoteAddress, unsigned short &remotePort)
Receive raw data from a remote peer.
sf::UdpSocket::receive
Status receive(Packet &packet, IpAddress &remoteAddress, unsigned short &remotePort)
Receive a formatted packet of data from a remote peer.