mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-24 21:53:37 +02:00
207 lines
8.2 KiB
C
207 lines
8.2 KiB
C
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
|
|
//
|
|
// This software is provided 'as-is', without any express or implied warranty.
|
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it freely,
|
|
// subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented;
|
|
// you must not claim that you wrote the original software.
|
|
// If you use this software in a product, an acknowledgment
|
|
// in the product documentation would be appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such,
|
|
// and must not be misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#ifndef SFML_UDPSOCKET_H
|
|
#define SFML_UDPSOCKET_H
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Network/Export.h>
|
|
#include <SFML/Network/IpAddress.h>
|
|
#include <SFML/Network/SocketStatus.h>
|
|
#include <SFML/Network/Types.h>
|
|
#include <stddef.h>
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Create a new UDP socket
|
|
///
|
|
/// \return A new sfUdpSocket object
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfUdpSocket* sfUdpSocket_create(void);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Destroy a UDP socket
|
|
///
|
|
/// \param socket UDP socket to destroy
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API void sfUdpSocket_destroy(sfUdpSocket* socket);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the blocking state of a UDP listener
|
|
///
|
|
/// In blocking mode, calls will not return until they have
|
|
/// completed their task. For example, a call to
|
|
/// sfUDPSocket_receive in blocking mode won't return until
|
|
/// new data was actually received.
|
|
/// In non-blocking mode, calls will always return immediately,
|
|
/// using the return code to signal whether there was data
|
|
/// available or not.
|
|
/// By default, all sockets are blocking.
|
|
///
|
|
/// \param socket UDP socket object
|
|
/// \param blocking sfTrue to set the socket as blocking, sfFalse for non-blocking
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API void sfUdpSocket_setBlocking(sfUdpSocket* socket, sfBool blocking);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Tell whether a UDP socket is in blocking or non-blocking mode
|
|
///
|
|
/// \param socket UDP socket object
|
|
///
|
|
/// \return sfTrue if the socket is blocking, sfFalse otherwise
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfBool sfUdpSocket_isBlocking(const sfUdpSocket* socket);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the port to which a UDP socket is bound locally
|
|
///
|
|
/// If the socket is not bound to a port, this function
|
|
/// returns 0.
|
|
///
|
|
/// \param socket UDP socket object
|
|
///
|
|
/// \return Port to which the socket is bound
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API unsigned short sfUdpSocket_getLocalPort(const sfUdpSocket* socket);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Bind a UDP socket to a specific port
|
|
///
|
|
/// Binding the socket to a port is necessary for being
|
|
/// able to receive data on that port.
|
|
/// You can use the special value 0 to tell the
|
|
/// system to automatically pick an available port, and then
|
|
/// call sfUdpSocket_getLocalPort to retrieve the chosen port.
|
|
///
|
|
/// \param socket UDP socket object
|
|
/// \param port Port to bind the socket to
|
|
///
|
|
/// \return Status code
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_bind(sfUdpSocket* socket, unsigned short port);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Unbind a UDP socket from the local port to which it is bound
|
|
///
|
|
/// The port that the socket was previously using is immediately
|
|
/// available after this function is called. If the
|
|
/// socket is not bound to a port, this function has no effect.
|
|
///
|
|
/// \param socket UDP socket object
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API void sfUdpSocket_unbind(sfUdpSocket* socket);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Send raw data to a remote peer with a UDP socket
|
|
///
|
|
/// Make sure that \a size is not greater than
|
|
/// sfUdpSocket_maxDatagramSize(), otherwise this function will
|
|
/// fail and no data will be sent.
|
|
///
|
|
/// \param socket UDP socket object
|
|
/// \param data Pointer to the sequence of bytes to send
|
|
/// \param size Number of bytes to send
|
|
/// \param remoteAddress Address of the receiver
|
|
/// \param remotePort Port of the receiver to send the data to
|
|
///
|
|
/// \return Status code
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress address, unsigned short port);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Receive raw data from a remote peer with a UDP socket
|
|
///
|
|
/// In blocking mode, this function will wait until some
|
|
/// bytes are actually received.
|
|
/// Be careful to use a buffer which is large enough for
|
|
/// the data that you intend to receive, if it is too small
|
|
/// then an error will be returned and *all* the data will
|
|
/// be lost.
|
|
///
|
|
/// \param socket UDP socket object
|
|
/// \param data Pointer to the array to fill with the received bytes
|
|
/// \param size Maximum number of bytes that can be received
|
|
/// \param received This variable is filled with the actual number of bytes received
|
|
/// \param remoteAddress Address of the peer that sent the data
|
|
/// \param remotePort Port of the peer that sent the data
|
|
///
|
|
/// \return Status code
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived, sfIpAddress* address, unsigned short* port);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Send a formatted packet of data to a remote peer with a UDP socket
|
|
///
|
|
/// Make sure that the packet size is not greater than
|
|
/// sfUdpSocket_maxDatagramSize(), otherwise this function will
|
|
/// fail and no data will be sent.
|
|
///
|
|
/// \param socket UDP socket object
|
|
/// \param packet Packet to send
|
|
/// \param remoteAddress Address of the receiver
|
|
/// \param remotePort Port of the receiver to send the data to
|
|
///
|
|
/// \return Status code
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress address, unsigned short port);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Receive a formatted packet of data from a remote peer with a UDP socket
|
|
///
|
|
/// In blocking mode, this function will wait until the whole packet
|
|
/// has been received.
|
|
///
|
|
/// \param packet Packet to fill with the received data
|
|
/// \param remoteAddress Address of the peer that sent the data
|
|
/// \param remotePort Port of the peer that sent the data
|
|
///
|
|
/// \return Status code
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* address, unsigned short* port);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Return the maximum number of bytes that can be
|
|
/// sent in a single UDP datagram
|
|
///
|
|
/// \return The maximum size of a UDP datagram (message)
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_NETWORK_API unsigned int sfUdpSocket_maxDatagramSize();
|
|
|
|
|
|
#endif // SFML_UDPSOCKET_H
|