SC::SocketClient Struct Reference

Use a SocketDescriptor as a client (example a TCP or UDP socket client). More...

#include <Socket.h>

Public Member Functions
	SocketClient (const SocketDescriptor &socket)
	Constructs this SocketClient from a SocketDescriptor (already created with SocketDescriptor::create)
Result	connect (SpanStringView address, uint16_t port)
	Connect to a given address and port combination.
Result	connect (SocketIPAddress ipAddress)
	Connect to a given address and port combination.
Result	write (Span< const char > data)
	Writes bytes to this socket.
Result	read (Span< char > data, Span< char > &readData)
	Read bytes from this socket blocking until they're actually received.
Result	readWithTimeout (Span< char > data, Span< char > &readData, Time::Milliseconds timeout)
	Read bytes from this socket blocking until they're actually received or timeout occurs.

Detailed Description

Use a SocketDescriptor as a client (example a TCP or UDP socket client).

The socket client can be obtained via SC::SocketServer::accept or connected to an endpoint through SC::SocketClient::connect.

Example (accepted client from server, doing a synchronous read):

    SocketDescriptor acceptedClientSocket;
    // ... assuming to obtain a TCP socket using SocketServer::accept
    SC_TRY(server.accept(family, acceptedClientSocket));
    SC_TRY(acceptedClientSocket.isValid());
 
    // Read some data blocking until it's available
    char buf[256];
 
    SocketClient acceptedClient(acceptedClientSocket);
    Span<char>   readData;
    SC_TRY(acceptedClient.read({buf, sizeof(buf)}, readData));
 
    // ... later on
 
    // Read again blocking but with a timeout of 10 seconds
    SC_TRY(acceptedClient.readWithTimeout({buf, sizeof(buf)}, readData, 10_sec));
 
    // Close the client
    SC_TRY(acceptedClientSocket.close());

Example (connecting client to server, doing two synchronous writes):

 
    // ...assuming there is a socket listening at given serverAddress and tcpPort
    SocketDescriptor clientSocket;
    SocketClient     client(clientSocket);
 
    // Create a (TCP) socket
    SC_TRY(clientSocket.create(family));
 
    // [Alternatively] Create an UDP socket instead
    // SC_TRY(clientSocket.create(family, SocketFlags::SocketDgram, SocketFlags::ProtocolUdp));
 
    // Connect to the server
    SC_TRY(client.connect(serverAddress, tcpPort));
 
    // Write some data to the socket
    const int testValue = 1;
    char      buf[1]    = {testValue};
    SC_TRY(client.write({buf, sizeof(buf)}));
    buf[0]++; // change the value and write again
    SC_TRY(client.write({buf, sizeof(buf)}));
 
    // Close the socket
    SC_TRY(clientSocket.close());

Constructor & Destructor Documentation

SocketClient()

SC::SocketClient::SocketClient ( const SocketDescriptor & socket )

inline

Constructs this SocketClient from a SocketDescriptor (already created with SocketDescriptor::create)

Parameters

socket

A socket descriptor created with SocketDescriptor::create to be used as client

Member Function Documentation

connect() [1/2]

Result SC::SocketClient::connect ( SocketIPAddress ipAddress )

nodiscard

Connect to a given address and port combination.

Parameters

ipAddress

Address and port to connect to

Returns

Valid Result if this client successfully connected to the specified address and port

connect() [2/2]

Result SC::SocketClient::connect ( SpanStringView address, uint16_t port )

nodiscard

Connect to a given address and port combination.

Parameters

address	Address as string
port	Port to start listening to

Returns

Valid Result if this client successfully connected to the specified address and port

Note

Socket descriptor MUST have already been created with SocketDescriptor::create

read()

Result SC::SocketClient::read ( Span< char > data, Span< char > & readData )

nodiscard

Read bytes from this socket blocking until they're actually received.

Parameters

[in]	data	Span of memory pointing at a buffer that will receive the read data
[out]	readData	A sub-Span of data that has the length of actually read bytes

Returns

Valid Result if bytes have been read successfully

readWithTimeout()

Result SC::SocketClient::readWithTimeout ( Span< char > data, Span< char > & readData, Time::Milliseconds timeout )

nodiscard

Read bytes from this socket blocking until they're actually received or timeout occurs.

Parameters

[in]	data	Span of memory pointing at a buffer that will receive the read data
[out]	readData	A sub-Span of data that has the length of actually read bytes
[in]	timeout	For how many milliseconds the read should wait before timing out

Returns

Valid Result if bytes have been read successfully and timeout didn't occur

write()

Result SC::SocketClient::write ( Span< const char > data )

nodiscard

Writes bytes to this socket.

Parameters

data	Bytes to write to this socket

Returns

Valid Result if bytes have been written successfully

---

The documentation for this struct was generated from the following file:

• Socket.h