CSFML - C binding of the Simple and Fast Multimedia Library

CSFML 3.0.0
Loading...
Searching...
No Matches
TcpSocket.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 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 <CSFML/Network/Export.h>
31
32#include <CSFML/Network/IpAddress.h>
33#include <CSFML/Network/SocketStatus.h>
34#include <CSFML/Network/Types.h>
35#include <CSFML/System/Time.h>
36
37#include <stddef.h>
38
39
46 CSFML_NETWORK_API sfTcpSocket* sfTcpSocket_create(void);
47
54 CSFML_NETWORK_API void sfTcpSocket_destroy(const sfTcpSocket* socket);
55
72 CSFML_NETWORK_API void sfTcpSocket_setBlocking(sfTcpSocket* socket, bool blocking);
73
82 CSFML_NETWORK_API bool sfTcpSocket_isBlocking(const sfTcpSocket* socket);
83
94 CSFML_NETWORK_API unsigned short sfTcpSocket_getLocalPort(const sfTcpSocket* socket);
95
107 CSFML_NETWORK_API sfIpAddress sfTcpSocket_getRemoteAddress(const sfTcpSocket* socket);
108
120 CSFML_NETWORK_API unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket* socket);
121
138 CSFML_NETWORK_API sfSocketStatus
139 sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout);
140
150 CSFML_NETWORK_API void sfTcpSocket_disconnect(sfTcpSocket* socket);
151
167 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_send(sfTcpSocket* socket, const void* data, size_t size);
168
182 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket* socket, const void* data, size_t size, size_t* sent);
183
199 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t size, size_t* received);
200
216 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_sendPacket(sfTcpSocket* socket, sfPacket* packet);
217
231 CSFML_NETWORK_API sfSocketStatus sfTcpSocket_receivePacket(sfTcpSocket* socket, sfPacket* packet);
IpAddress.h
Export.h
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition Network/Export.h:42
Types.h
sfPacket
struct sfPacket sfPacket
Definition Network/Types.h:35
sfTcpSocket
struct sfTcpSocket sfTcpSocket
Definition Network/Types.h:38
SocketStatus.h
sfSocketStatus
sfSocketStatus
Define the status that can be returned by the socket functions.
Definition SocketStatus.h:32
sfTcpSocket_send
sfSocketStatus sfTcpSocket_send(sfTcpSocket *socket, const void *data, size_t size)
Send raw data to the remote peer of a TCP socket.
sfTcpSocket_sendPacket
sfSocketStatus sfTcpSocket_sendPacket(sfTcpSocket *socket, sfPacket *packet)
Send a formatted packet of data to the remote peer of a TCP socket.
sfTcpSocket_receivePacket
sfSocketStatus sfTcpSocket_receivePacket(sfTcpSocket *socket, sfPacket *packet)
Receive a formatted packet of data from the remote peer.
sfTcpSocket_sendPartial
sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket *socket, const void *data, size_t size, size_t *sent)
Send raw data to the remote peer.
sfTcpSocket_getRemotePort
unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket *socket)
Get the port of the connected peer to which a TCP socket is connected.
sfTcpSocket_getLocalPort
unsigned short sfTcpSocket_getLocalPort(const sfTcpSocket *socket)
Get the port to which a TCP socket is bound locally.
sfTcpSocket_getRemoteAddress
sfIpAddress sfTcpSocket_getRemoteAddress(const sfTcpSocket *socket)
Get the address of the connected peer of a TCP socket.
sfTcpSocket_disconnect
void sfTcpSocket_disconnect(sfTcpSocket *socket)
Disconnect a TCP socket from its remote peer.
sfTcpSocket_receive
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_isBlocking
bool sfTcpSocket_isBlocking(const sfTcpSocket *socket)
Tell whether a TCP socket is in blocking or non-blocking mode.
sfTcpSocket_setBlocking
void sfTcpSocket_setBlocking(sfTcpSocket *socket, bool blocking)
Set the blocking state of a TCP listener.
sfTcpSocket_destroy
void sfTcpSocket_destroy(const sfTcpSocket *socket)
Destroy a TCP socket.
sfTcpSocket_create
sfTcpSocket * sfTcpSocket_create(void)
Create a new TCP socket.
sfTcpSocket_connect
sfSocketStatus sfTcpSocket_connect(sfTcpSocket *socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout)
Connect a TCP socket to a remote peer.
Time.h
sfIpAddress
Encapsulate an IPv4 network address.
Definition IpAddress.h:40
sfTime
Represents a time value.
Definition Time.h:38