CSFML
TcpSocket.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_TCPSOCKET_H
26 #define SFML_TCPSOCKET_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 <SFML/System/Time.h>
36 #include <stddef.h>
37
38
45 CSFML_NETWORK_API sfTcpSocket* sfTcpSocket_create(void);
46
53 CSFML_NETWORK_API void sfTcpSocket_destroy(sfTcpSocket* socket);
54
71 CSFML_NETWORK_API void sfTcpSocket_setBlocking(sfTcpSocket* socket, sfBool blocking);
72
81 CSFML_NETWORK_API sfBool sfTcpSocket_isBlocking(const sfTcpSocket* socket);
82
93 CSFML_NETWORK_API unsigned short sfTcpSocket_getLocalPort(const sfTcpSocket* socket);
94
106 CSFML_NETWORK_API sfIpAddress sfTcpSocket_getRemoteAddress(const sfTcpSocket* socket);
107
119 CSFML_NETWORK_API unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket* socket);
120
137 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout);
138
148 CSFML_NETWORK_API void sfTcpSocket_disconnect(sfTcpSocket* socket);
149
165 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_send(sfTcpSocket* socket, const void* data, size_t size);
166
180 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket* socket, const void* data, size_t size, size_t* sent);
181
197 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t size, size_t* received);
198
214 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPacket(sfTcpSocket* socket, sfPacket* packet);
215
229 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receivePacket(sfTcpSocket* socket, sfPacket* packet);
230
231
232 #endif // SFML_TCPSOCKET_H
Types.h
sfTcpSocket_receive
CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receive(sfTcpSocket *socket, void *data, size_t size, size_t *received)
Receive raw data from the remote peer of a TCP socket.
sfTcpSocket_setBlocking
CSFML_NETWORK_API void sfTcpSocket_setBlocking(sfTcpSocket *socket, sfBool blocking)
Set the blocking state of a TCP listener.
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition: Network/Export.h:43
sfTcpSocket_destroy
CSFML_NETWORK_API void sfTcpSocket_destroy(sfTcpSocket *socket)
Destroy a TCP socket.
sfTcpSocket_connect
CSFML_NETWORK_API sfSocketStatus sfTcpSocket_connect(sfTcpSocket *socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout)
Connect a TCP socket to a remote peer.
SocketStatus.h
sfTcpSocket_isBlocking
CSFML_NETWORK_API sfBool sfTcpSocket_isBlocking(const sfTcpSocket *socket)
Tell whether a TCP socket is in blocking or non-blocking mode.
sfIpAddress
Encapsulate an IPv4 network address.
Definition: IpAddress.h:39
sfTcpSocket_send
CSFML_NETWORK_API sfSocketStatus sfTcpSocket_send(sfTcpSocket *socket, const void *data, size_t size)
Send raw data to the remote peer of a TCP socket.
sfTcpSocket_getLocalPort
CSFML_NETWORK_API unsigned short sfTcpSocket_getLocalPort(const sfTcpSocket *socket)
Get the port to which a TCP socket is bound locally.
sfTcpSocket_receivePacket
CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receivePacket(sfTcpSocket *socket, sfPacket *packet)
Receive a formatted packet of data from the remote peer.
sfBool
int sfBool
Definition: Config.h:153
sfTcpSocket_sendPartial
CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket *socket, const void *data, size_t size, size_t *sent)
Send raw data to the remote peer.
sfTcpSocket_disconnect
CSFML_NETWORK_API void sfTcpSocket_disconnect(sfTcpSocket *socket)
Disconnect a TCP socket from its remote peer.
sfTcpSocket_getRemoteAddress
CSFML_NETWORK_API sfIpAddress sfTcpSocket_getRemoteAddress(const sfTcpSocket *socket)
Get the address of the connected peer of a TCP socket.
sfTime
Represents a time value.
Definition: Time.h:38
sfPacket
struct sfPacket sfPacket
Definition: Network/Types.h:36
sfTcpSocket_sendPacket
CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPacket(sfTcpSocket *socket, sfPacket *packet)
Send a formatted packet of data to the remote peer of a TCP socket.
IpAddress.h
sfTcpSocket
struct sfTcpSocket sfTcpSocket
Definition: Network/Types.h:39
sfTcpSocket_create
CSFML_NETWORK_API sfTcpSocket * sfTcpSocket_create(void)
Create a new TCP socket.
sfTcpSocket_getRemotePort
CSFML_NETWORK_API unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket *socket)
Get the port of the connected peer to which a TCP socket is connected.
Export.h
Time.h
sfSocketStatus
sfSocketStatus
Define the status that can be returned by the socket functions.
Definition: SocketStatus.h:33