#include <SocketTCP.hpp>
Public Member Functions | |
SocketTCP () | |
Default constructor. | |
void | SetBlocking (bool Blocking) |
Change the blocking state of the socket. | |
Socket::Status | Connect (unsigned short Port, const IPAddress &HostAddress, float Timeout=0.f) |
Connect to another computer on a specified port. | |
bool | Listen (unsigned short Port) |
Listen to a specified port for incoming data or connections. | |
Socket::Status | Accept (SocketTCP &Connected, IPAddress *Address=NULL) |
Wait for a connection (must be listening to a port). | |
Socket::Status | Send (const char *Data, std::size_t Size) |
Send an array of bytes to the host (must be connected first). | |
Socket::Status | Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived) |
Receive an array of bytes from the host (must be connected first). | |
Socket::Status | Send (Packet &PacketToSend) |
Send a packet of data to the host (must be connected first). | |
Socket::Status | Receive (Packet &PacketToReceive) |
Receive a packet from the host (must be connected first). | |
bool | Close () |
Close the socket. | |
bool | IsValid () const |
Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK. | |
bool | operator== (const SocketTCP &Other) const |
Comparison operator ==. | |
bool | operator!= (const SocketTCP &Other) const |
Comparison operator !=. | |
bool | operator< (const SocketTCP &Other) const |
Comparison operator <. | |
Friends | |
class | Selector< SocketTCP > |
Definition at line 45 of file SocketTCP.hpp.
sf::SocketTCP::SocketTCP | ( | ) |
Wait for a connection (must be listening to a port).
This function will block if the socket is blocking
Connected | : Socket containing the connection with the connected client | |
Address | : Pointer to an address to fill with client infos (NULL by default) |
Definition at line 206 of file SocketTCP.cpp.
bool sf::SocketTCP::Close | ( | ) |
Close the socket.
Definition at line 406 of file SocketTCP.cpp.
Socket::Status sf::SocketTCP::Connect | ( | unsigned short | Port, | |
const IPAddress & | HostAddress, | |||
float | Timeout = 0.f | |||
) |
Connect to another computer on a specified port.
Port | : Port to use for transfers (warning : ports < 1024 are reserved) | |
HostAddress | : IP Address of the host to connect to | |
Timeout | : Maximum time to wait, in seconds (0 by default : no timeout) (this parameter is ignored for non-blocking sockets) |
Definition at line 70 of file SocketTCP.cpp.
bool sf::SocketTCP::IsValid | ( | ) | const |
Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
Definition at line 429 of file SocketTCP.cpp.
bool sf::SocketTCP::Listen | ( | unsigned short | Port | ) |
Listen to a specified port for incoming data or connections.
Port | : Port to listen to |
Definition at line 169 of file SocketTCP.cpp.
bool sf::SocketTCP::operator!= | ( | const SocketTCP & | Other | ) | const |
Comparison operator !=.
Other | : Socket to compare |
Definition at line 447 of file SocketTCP.cpp.
bool sf::SocketTCP::operator< | ( | const SocketTCP & | Other | ) | const |
Comparison operator <.
Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...
Other | : Socket to compare |
Definition at line 458 of file SocketTCP.cpp.
bool sf::SocketTCP::operator== | ( | const SocketTCP & | Other | ) | const |
Comparison operator ==.
Other | : Socket to compare |
Definition at line 438 of file SocketTCP.cpp.
Socket::Status sf::SocketTCP::Receive | ( | Packet & | PacketToReceive | ) |
Receive a packet from the host (must be connected first).
This function will block if the socket is blocking
PacketToReceive | : Packet to fill with received data |
Definition at line 340 of file SocketTCP.cpp.
Socket::Status sf::SocketTCP::Receive | ( | char * | Data, | |
std::size_t | MaxSize, | |||
std::size_t & | SizeReceived | |||
) |
Receive an array of bytes from the host (must be connected first).
This function will block if the socket is blocking
Data | : Pointer to a byte array to fill (make sure it is big enough) | |
MaxSize | : Maximum number of bytes to read | |
SizeReceived | : Number of bytes received |
Definition at line 272 of file SocketTCP.cpp.
Socket::Status sf::SocketTCP::Send | ( | Packet & | PacketToSend | ) |
Send a packet of data to the host (must be connected first).
PacketToSend | : Packet to send |
Definition at line 314 of file SocketTCP.cpp.
Socket::Status sf::SocketTCP::Send | ( | const char * | Data, | |
std::size_t | Size | |||
) |
Send an array of bytes to the host (must be connected first).
Data | : Pointer to the bytes to send | |
Size | : Number of bytes to send |
Definition at line 235 of file SocketTCP.cpp.
void sf::SocketTCP::SetBlocking | ( | bool | Blocking | ) |
Change the blocking state of the socket.
The default behaviour of a socket is blocking
Blocking | : Pass true to set the socket as blocking, or false for non-blocking |
Definition at line 56 of file SocketTCP.cpp.