CSFML - C binding of the Simple and Fast Multimedia Library

CSFML
UdpSocket.h
Go to the documentation of this file.
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 SFML_UDPSOCKET_H
26 #define SFML_UDPSOCKET_H
27
29 // Headers
31 #include <SFML/Network/Export.h>
32 #include <SFML/Network/IpAddress.h>
33 #include <SFML/Network/SocketStatus.h>
34 #include <SFML/Network/Types.h>
35 #include <stddef.h>
36
37
44 CSFML_NETWORK_API sfUdpSocket* sfUdpSocket_create(void);
45
52 CSFML_NETWORK_API void sfUdpSocket_destroy(sfUdpSocket* socket);
53
70 CSFML_NETWORK_API void sfUdpSocket_setBlocking(sfUdpSocket* socket, sfBool blocking);
71
80 CSFML_NETWORK_API sfBool sfUdpSocket_isBlocking(const sfUdpSocket* socket);
81
93 CSFML_NETWORK_API unsigned short sfUdpSocket_getLocalPort(const sfUdpSocket* socket);
94
113 CSFML_NETWORK_API sfSocketStatus sfUdpSocket_bind(sfUdpSocket* socket, unsigned short port, sfIpAddress address);
114
125 CSFML_NETWORK_API void sfUdpSocket_unbind(sfUdpSocket* socket);
126
143 CSFML_NETWORK_API sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress remoteAddress, unsigned short remotePort);
144
165 CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t size, size_t* received, sfIpAddress* remoteAddress, unsigned short* remotePort);
166
182 CSFML_NETWORK_API sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress remoteAddress, unsigned short remotePort);
183
197 CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* remoteAddress, unsigned short* remotePort);
198
206 CSFML_NETWORK_API unsigned int sfUdpSocket_maxDatagramSize();
207
208
209 #endif // SFML_UDPSOCKET_H
sfUdpSocket_receive
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receive(sfUdpSocket *socket, void *data, size_t size, size_t *received, sfIpAddress *remoteAddress, unsigned short *remotePort)
Receive raw data from a remote peer with a UDP socket.
Types.h
sfUdpSocket_destroy
CSFML_NETWORK_API void sfUdpSocket_destroy(sfUdpSocket *socket)
Destroy a UDP socket.
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition: Network/Export.h:43
sfUdpSocket_setBlocking
CSFML_NETWORK_API void sfUdpSocket_setBlocking(sfUdpSocket *socket, sfBool blocking)
Set the blocking state of a UDP listener.
sfUdpSocket_bind
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_bind(sfUdpSocket *socket, unsigned short port, sfIpAddress address)
Bind a UDP socket to a specific port.
sfUdpSocket_create
CSFML_NETWORK_API sfUdpSocket * sfUdpSocket_create(void)
Create a new UDP socket.
SocketStatus.h
sfUdpSocket
struct sfUdpSocket sfUdpSocket
Definition: Network/Types.h:40
sfIpAddress
Encapsulate an IPv4 network address.
Definition: IpAddress.h:39
sfBool
int sfBool
Definition: Config.h:153
sfUdpSocket_sendPacket
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket *socket, sfPacket *packet, sfIpAddress remoteAddress, unsigned short remotePort)
Send a formatted packet of data to a remote peer with a UDP socket.
sfPacket
struct sfPacket sfPacket
Definition: Network/Types.h:36
IpAddress.h
sfUdpSocket_send
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_send(sfUdpSocket *socket, const void *data, size_t size, sfIpAddress remoteAddress, unsigned short remotePort)
Send raw data to a remote peer with a UDP socket.
sfUdpSocket_isBlocking
CSFML_NETWORK_API sfBool sfUdpSocket_isBlocking(const sfUdpSocket *socket)
Tell whether a UDP socket is in blocking or non-blocking mode.
sfUdpSocket_getLocalPort
CSFML_NETWORK_API unsigned short sfUdpSocket_getLocalPort(const sfUdpSocket *socket)
Get the port to which a UDP socket is bound locally.
Export.h
sfUdpSocket_maxDatagramSize
CSFML_NETWORK_API unsigned int sfUdpSocket_maxDatagramSize()
Return the maximum number of bytes that can be sent in a single UDP datagram.
sfUdpSocket_unbind
CSFML_NETWORK_API void sfUdpSocket_unbind(sfUdpSocket *socket)
Unbind a UDP socket from the local port to which it is bound.
sfUdpSocket_receivePacket
CSFML_NETWORK_API sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket *socket, sfPacket *packet, sfIpAddress *remoteAddress, unsigned short *remotePort)
Receive a formatted packet of data from a remote peer with a UDP socket.
sfSocketStatus
sfSocketStatus
Define the status that can be returned by the socket functions.
Definition: SocketStatus.h:33