Loading...
Searching...
No Matches
UdpSocket.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2025 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#pragma once
26
28// Headers
30#include <SFML/Network/Export.hpp>
31
32#include <SFML/Network/IpAddress.hpp>
33#include <SFML/Network/Socket.hpp>
34
35#include <optional>
36#include <vector>
37
38#include <cstddef>
39
40
41namespace sf
42{
43class Packet;
44
49class SFML_NETWORK_API UdpSocket : public Socket
50{
51public:
53 // Constants
55 // NOLINTNEXTLINE(readability-identifier-naming)
56 static constexpr std::size_t MaxDatagramSize{65507};
57
62 UdpSocket();
63
75 [[nodiscard]] unsigned short getLocalPort() const;
76
100 [[nodiscard]] Status bind(unsigned short port, IpAddress address = IpAddress::Any);
101
114 void unbind();
115
133 [[nodiscard]] Status send(const void* data, std::size_t size, IpAddress remoteAddress, unsigned short remotePort);
134
156 [[nodiscard]] Status receive(void* data,
157 std::size_t size,
158 std::size_t& received,
159 std::optional<IpAddress>& remoteAddress,
160 unsigned short& remotePort);
161
178 [[nodiscard]] Status send(Packet& packet, IpAddress remoteAddress, unsigned short remotePort);
179
195 [[nodiscard]] Status receive(Packet& packet, std::optional<IpAddress>& remoteAddress, unsigned short& remotePort);
196
197private:
199 // Member data
201 std::vector<std::byte> m_buffer{MaxDatagramSize};
202};
203
204} // namespace sf
205
206
SFML_NETWORK_API
#define SFML_NETWORK_API
Definition Network/Export.hpp:42
sf::IpAddress
Encapsulate an IPv4 network address.
Definition IpAddress.hpp:49
sf::IpAddress::Any
static const IpAddress Any
Value representing any address (0.0.0.0)
Definition IpAddress.hpp:168
sf::Packet
Utility class to build blocks of data to transfer over the network.
Definition Packet.hpp:49
sf::Socket::Status
Status
Status codes that may be returned by socket functions.
Definition Socket.hpp:49
sf::Socket::Socket
Socket(const Socket &)=delete
Deleted copy constructor.
sf::UdpSocket::bind
Status bind(unsigned short port, IpAddress address=IpAddress::Any)
Bind the socket to a specific port.
sf::UdpSocket::unbind
void unbind()
Unbind the socket from the local port to which it is bound.
sf::UdpSocket::receive
Status receive(void *data, std::size_t size, std::size_t &received, std::optional< IpAddress > &remoteAddress, unsigned short &remotePort)
Receive raw data from a remote peer.
sf::UdpSocket::receive
Status receive(Packet &packet, std::optional< IpAddress > &remoteAddress, unsigned short &remotePort)
Receive a formatted packet of data from 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, IpAddress remoteAddress, unsigned short remotePort)
Send raw data to a remote peer.
sf::UdpSocket::MaxDatagramSize
static constexpr std::size_t MaxDatagramSize
The maximum number of bytes that can be sent in a single UDP datagram.
Definition UdpSocket.hpp:56
sf::UdpSocket::send
Status send(Packet &packet, IpAddress remoteAddress, unsigned short remotePort)
Send a formatted packet of data to a remote peer.
sf::UdpSocket::UdpSocket
UdpSocket()
Default constructor.