StormByte::Network::Client Class Reference

The class representing a client. More...

#include <client.hxx>

Inheritance diagram for StormByte::Network::Client:

Collaboration diagram for StormByte::Network::Client:

Public Member Functions
	Client (const Connection::Protocol &protocol, std::shared_ptr< Connection::Handler > handler, std::shared_ptr< Logger > logger) noexcept
	The constructor of the Client class.
	Client (const Client &other)=delete
	The copy constructor of the Client class.
	Client (Client &&other) noexcept=default
	The move constructor of the Client class.
virtual	~Client () noexcept override=default
	The destructor of the Client class.
Client &	operator= (const Client &other)=delete
	The assignment operator of the Client class.
Client &	operator= (Client &&other) noexcept=default
	The assignment operator of the Client class.
virtual ExpectedVoid	Connect (const std::string &hostname, const unsigned short &port) noexcept override
	The function to connect a server.
ExpectedPacket	Receive () noexcept
	The function to receive data from the server.
ExpectedVoid	Send (const Packet &packet) noexcept
	The function to send data to the server.
Public Member Functions inherited from StormByte::Network::EndPoint
	EndPoint (const Connection::Protocol &protocol, std::shared_ptr< Connection::Handler > handler, std::shared_ptr< Logger > logger) noexcept
	Constructs an EndPoint with the specified protocol, handler, and logger.
	EndPoint (const EndPoint &other)=delete
	Deleted copy constructor to prevent copying.
	EndPoint (EndPoint &&other) noexcept=default
	Defaulted move constructor.
virtual	~EndPoint () noexcept
	Virtual destructor for proper cleanup in derived classes.
EndPoint &	operator= (const EndPoint &other)=delete
	Deleted copy assignment operator to prevent copying.
EndPoint &	operator= (EndPoint &&other) noexcept=default
	Defaulted move assignment operator.
virtual void	Disconnect () noexcept
	Stops the endpoint (client or server) and disconnects.
const Connection::Protocol &	Protocol () const noexcept
	Retrieves the protocol used by the endpoint.
Connection::Status	Status () const noexcept
	Retrieves the current connection status of the endpoint.

Additional Inherited Members
Protected Member Functions inherited from StormByte::Network::EndPoint
virtual ExpectedVoid	Handshake (Socket::Client &client) noexcept
	Sets up the connection handler for the endpoint.
virtual ExpectedVoid	Authenticate (Socket::Client &client) noexcept
	Authenticates the client connection.
ExpectedPacket	Receive (Socket::Client &client) noexcept
	Receives packet from the client processing pipeline before constructing packet.
ExpectedPacket	RawReceive (Socket::Client &client) noexcept
	Receives packet from the client without processing pipeline before constructing packet.
ExpectedVoid	Send (Socket::Client &client, const Packet &packet) noexcept
	Sends a packet to the client processing pipeline before sending packet.
ExpectedVoid	RawSend (Socket::Client &client, const Packet &packet) noexcept
	Sends a packet to the client without processing pipeline before sending packet.
Protected Attributes inherited from StormByte::Network::EndPoint
Connection::Protocol	m_protocol
	The protocol used by the endpoint (e.g., IPv4, IPv6).
std::shared_ptr< Connection::Handler >	m_handler
	Shared pointer to the connection handler.
std::shared_ptr< Logger >	m_logger
	Shared pointer to the logger instance.
std::atomic< Connection::Status >	m_status
	The current connection status of the endpoint.
Socket::Socket *	m_socket
	Unique pointer to the socket instance.
Buffer::Pipeline	m_input_pipeline
Buffer::Pipeline	m_output_pipeline
	The input/output pipeline for processing data.

Detailed Description

The class representing a client.

Constructor & Destructor Documentation

Client() [1/3]

StormByte::Network::Client::Client ( const Connection::Protocol &  protocol, std::shared_ptr< Connection::Handler >  handler, std::shared_ptr< Logger >  logger  )

noexcept

The constructor of the Client class.

Parameters

address	The address of the server.
handler	The handler of the server.

Client() [2/3]

StormByte::Network::Client::Client ( const Client &  other )

delete

The copy constructor of the Client class.

Parameters

other

The other server to copy.

Client() [3/3]

StormByte::Network::Client::Client ( Client &&  other )

defaultnoexcept

The move constructor of the Client class.

Parameters

other

The other server to move.

Member Function Documentation

Connect()

virtual ExpectedVoid StormByte::Network::Client::Connect ( const std::string &  hostname, const unsigned short &  port  )

overridevirtualnoexcept

The function to connect a server.

Parameters

hostname	The hostname of the server.
port	The port of the server.
protocol	The protocol of the server.

Returns

The expected void or error.

Implements StormByte::Network::EndPoint.

operator=() [1/2]

Client & StormByte::Network::Client::operator= ( Client &&  other )

defaultnoexcept

The assignment operator of the Client class.

Parameters

other

The other server to assign.

Returns

The reference to the assigned server.

operator=() [2/2]

Client & StormByte::Network::Client::operator= ( const Client &  other )

delete

The assignment operator of the Client class.

Parameters

other

The other server to assign.

Returns

The reference to the assigned server.

Receive()

ExpectedPacket StormByte::Network::Client::Receive ( )

noexcept

The function to receive data from the server.

Returns

The expected buffer or error.

Send()

ExpectedVoid StormByte::Network::Client::Send ( const Packet &  packet )

noexcept

The function to send data to the server.

Parameters

packet

The packet to send.

Returns

The expected void or error.

---

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

• /home/runner/work/StormByte-Network/StormByte-Network/lib/public/StormByte/network/client.hxx