TcpSocket

Specialized socket using the TCP protocol.

TCP is a connected protocol, which means that a TCP socket can only communicate with the host it is connected to.

It can't send or receive anything if it is not connected.

The TCP protocol is reliable but adds a slight overhead. It ensures that your data will always be received in order and without errors (no data corrupted, lost or duplicated).

When a socket is connected to a remote host, you can retrieve informations about this host with the getRemoteAddress and getRemotePort functions. You can also get the local port to which the socket is bound (which is automatically chosen when the socket is connected), with the getLocalPort function.

Sending and receiving data can use either the low-level or the high-level functions. The low-level functions process a raw sequence of bytes, and cannot ensure that one call to Send will exactly match one call to Receive at the other end of the socket.

The high-level interface uses packets (see sf::Packet), which are easier to use and provide more safety regarding the data that is exchanged. You can look at the sf::Packet class to get more details about how they work.

The socket is automatically disconnected when it is destroyed, but if you want to explicitely close the connection while the socket instance is still alive, you can call disconnect.

class TcpSocket : Socket {

package

sfTcpSocket* sfPtr;

this();

~this();

ushort getLocalPort();

IpAddress getRemoteAddress();

ushort getRemotePort();

void setBlocking(bool blocking);

Status connect(IpAddress host, ushort port, Duration timeout);

void disconnect();

bool isBlocking();

Status send(const(void)[] data);

Status send(Packet packet);

Status receive(void[] data, size_t sizeReceived);

Status receive(Packet packet);

}

Constructors

this this(): Default constructor

Destructor

~this ~this(): Destructor

Members

Functions

connect Status connect(IpAddress host, ushort port, Duration timeout): Connect the socket to a remote peer.
disconnect void disconnect(): Disconnect the socket from its remote peer.
getLocalPort ushort getLocalPort(): Get the port to which the socket is bound locally.
getRemoteAddress IpAddress getRemoteAddress(): Get the address of the connected peer.
getRemotePort ushort getRemotePort(): Get the port of the connected peer to which the socket is connected.
isBlocking bool isBlocking(): Tell whether the socket is in blocking or non-blocking mode.
receive Status receive(Packet packet): In blocking mode, this function will wait until the whole packet has been received. This function will fail if the socket is not connected.
receive Status receive(void[] data, size_t sizeReceived): Receive raw data from the remote peer.
send Status send(const(void)[] data): Send raw data to the remote peer.
send Status send(Packet packet): Send a formatted packet of data to the remote peer.
setBlocking void setBlocking(bool blocking): Set the blocking state of the socket.

Variables

sfPtr sfTcpSocket* sfPtr;: Undocumented in source.

Inherited Members

From Socket

Status enum Status: Status codes that may be returned by socket functions.
AnyPort enum AnyPort;: Special value that tells the system to pick any available port.