CSFML
SocketSelector.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_SOCKETSELECTOR_H
26 #define SFML_SOCKETSELECTOR_H
27
29 // Headers
31 #include <SFML/Network/Export.h>
32 #include <SFML/Network/Types.h>
33 #include <SFML/System/Time.h>
34
35
42 CSFML_NETWORK_API sfSocketSelector* sfSocketSelector_create(void);
43
52 CSFML_NETWORK_API sfSocketSelector* sfSocketSelector_copy(const sfSocketSelector* selector);
53
60 CSFML_NETWORK_API void sfSocketSelector_destroy(sfSocketSelector* selector);
61
73 CSFML_NETWORK_API void sfSocketSelector_addTcpListener(sfSocketSelector* selector, sfTcpListener* socket);
74 CSFML_NETWORK_API void sfSocketSelector_addTcpSocket(sfSocketSelector* selector, sfTcpSocket* socket);
75 CSFML_NETWORK_API void sfSocketSelector_addUdpSocket(sfSocketSelector* selector, sfUdpSocket* socket);
76
87 CSFML_NETWORK_API void sfSocketSelector_removeTcpListener(sfSocketSelector* selector, sfTcpListener* socket);
88 CSFML_NETWORK_API void sfSocketSelector_removeTcpSocket(sfSocketSelector* selector, sfTcpSocket* socket);
89 CSFML_NETWORK_API void sfSocketSelector_removeUdpSocket(sfSocketSelector* selector, sfUdpSocket* socket);
90
101 CSFML_NETWORK_API void sfSocketSelector_clear(sfSocketSelector* selector);
102
118 CSFML_NETWORK_API sfBool sfSocketSelector_wait(sfSocketSelector* selector, sfTime timeout);
119
136 CSFML_NETWORK_API sfBool sfSocketSelector_isTcpListenerReady(const sfSocketSelector* selector, sfTcpListener* socket);
137 CSFML_NETWORK_API sfBool sfSocketSelector_isTcpSocketReady(const sfSocketSelector* selector, sfTcpSocket* socket);
138 CSFML_NETWORK_API sfBool sfSocketSelector_isUdpSocketReady(const sfSocketSelector* selector, sfUdpSocket* socket);
139
140
141 #endif // SFML_SOCKETSELECTOR_H
Types.h
sfSocketSelector_removeUdpSocket
CSFML_NETWORK_API void sfSocketSelector_removeUdpSocket(sfSocketSelector *selector, sfUdpSocket *socket)
sfSocketSelector_destroy
CSFML_NETWORK_API void sfSocketSelector_destroy(sfSocketSelector *selector)
Destroy a socket selector.
sfSocketSelector_addUdpSocket
CSFML_NETWORK_API void sfSocketSelector_addUdpSocket(sfSocketSelector *selector, sfUdpSocket *socket)
sfSocketSelector_removeTcpListener
CSFML_NETWORK_API void sfSocketSelector_removeTcpListener(sfSocketSelector *selector, sfTcpListener *socket)
Remove a socket from a socket selector.
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition: Network/Export.h:43
sfSocketSelector_isTcpSocketReady
CSFML_NETWORK_API sfBool sfSocketSelector_isTcpSocketReady(const sfSocketSelector *selector, sfTcpSocket *socket)
sfSocketSelector_removeTcpSocket
CSFML_NETWORK_API void sfSocketSelector_removeTcpSocket(sfSocketSelector *selector, sfTcpSocket *socket)
sfSocketSelector_clear
CSFML_NETWORK_API void sfSocketSelector_clear(sfSocketSelector *selector)
Remove all the sockets stored in a selector.
sfUdpSocket
struct sfUdpSocket sfUdpSocket
Definition: Network/Types.h:40
sfSocketSelector_addTcpListener
CSFML_NETWORK_API void sfSocketSelector_addTcpListener(sfSocketSelector *selector, sfTcpListener *socket)
Add a new socket to a socket selector.
sfBool
int sfBool
Definition: Config.h:153
sfSocketSelector_wait
CSFML_NETWORK_API sfBool sfSocketSelector_wait(sfSocketSelector *selector, sfTime timeout)
Wait until one or more sockets are ready to receive.
sfTime
Represents a time value.
Definition: Time.h:38
sfSocketSelector_addTcpSocket
CSFML_NETWORK_API void sfSocketSelector_addTcpSocket(sfSocketSelector *selector, sfTcpSocket *socket)
sfSocketSelector
struct sfSocketSelector sfSocketSelector
Definition: Network/Types.h:37
sfSocketSelector_isUdpSocketReady
CSFML_NETWORK_API sfBool sfSocketSelector_isUdpSocketReady(const sfSocketSelector *selector, sfUdpSocket *socket)
sfTcpListener
struct sfTcpListener sfTcpListener
Definition: Network/Types.h:38
sfTcpSocket
struct sfTcpSocket sfTcpSocket
Definition: Network/Types.h:39
sfSocketSelector_copy
CSFML_NETWORK_API sfSocketSelector * sfSocketSelector_copy(const sfSocketSelector *selector)
Create a new socket selector by copying an existing one.
sfSocketSelector_create
CSFML_NETWORK_API sfSocketSelector * sfSocketSelector_create(void)
Create a new selector.
sfSocketSelector_isTcpListenerReady
CSFML_NETWORK_API sfBool sfSocketSelector_isTcpListenerReady(const sfSocketSelector *selector, sfTcpListener *socket)
Test a socket to know if it is ready to receive data.
Export.h
Time.h