StormByte::Network::Server Class Reference

Abstract base for application-specific servers. More...

#include <server.hxx>

Inheritance diagram for StormByte::Network::Server:

Collaboration diagram for StormByte::Network::Server:

Public Member Functions
	Server (const DeserializePacketFunction &deserialize_packet_function, std::shared_ptr< Logger::Log > logger) noexcept
	Constructs a Server instance.
	Server (const Server &other)=delete
	Copy constructor (deleted).
	Server (Server &&other) noexcept=default
	Move constructor.
virtual	~Server () noexcept
	Virtual destructor.
Server &	operator= (const Server &other)=delete
	Copy-assignment operator (deleted).
Server &	operator= (Server &&other) noexcept=default
	Move-assignment operator.
bool	Connect (const Connection::Protocol &protocol, const std::string &address, const unsigned short &port) override
	Start the server and begin listening for connections.
void	Disconnect () noexcept override
	Stop the server and disconnect all clients.
Connection::Status	Status () const noexcept override
	Gets the current server connection status.

Protected Member Functions
void	DisconnectClient (const std::string &uuid) noexcept
	Disconnects a client by UUID.

Detailed Description

Abstract base for application-specific servers.

Subclass Server to implement your server-side application logic. The constructor accepts a DeserializePacketFunction and a Logger::ThreadedLog instance; the deserializer converts opcode + payload bytes into concrete Transport::Packet instances used by the framework.

Key extension points:

• Implement ProcessClientPacket() to inspect incoming packets and return a PacketPointer that will be sent back to the requesting client. If error return nullptr.
• Override InputPipeline() and OutputPipeline() to add buffer preprocessing/postprocessing stages (compression, encryption, etc.).
• Provide a concrete (out-of-line) destructor implementation in derived classes (the base destructor is declared pure to force an out-of-line override).

Implementation notes:

• The Server base manages listening, accepting, per-client threads and the underlying socket server; application logic should reside in ProcessClientPacket() or other overridable helpers.

Constructor & Destructor Documentation

Server()

StormByte::Network::Server::Server ( const DeserializePacketFunction &  deserialize_packet_function, std::shared_ptr< Logger::Log >  logger  )

noexcept

Constructs a Server instance.

Parameters

deserialize_packet_function	Function used to deserialize incoming transport packets into domain Packet objects.
logger	Logger instance used for diagnostic messages.

~Server()

virtual StormByte::Network::Server::~Server ( )

virtualnoexcept

Virtual destructor.

Declared pure to make Server an abstract base. Concrete subclasses must provide an implementation for the destructor (even if defaulted) in their translation unit.

Member Function Documentation

Connect()

bool StormByte::Network::Server::Connect ( const Connection::Protocol &  protocol, const std::string &  address, const unsigned short &  port  )

overridevirtual

Start the server and begin listening for connections.

Parameters

protocol	The protocol to use for the server.
address	The address to bind to.
port	The port to listen on.

Returns

True if the server started successfully, false otherwise.

Implements StormByte::Network::Endpoint.

Disconnect()

void StormByte::Network::Server::Disconnect ( )

overridevirtualnoexcept

Stop the server and disconnect all clients.

Implements StormByte::Network::Endpoint.

DisconnectClient()

void StormByte::Network::Server::DisconnectClient ( const std::string &  uuid )

protectednoexcept

Disconnects a client by UUID.

Parameters

client_uuid

The UUID of the client to be disconnected.

Status()

Connection::Status StormByte::Network::Server::Status ( ) const

inlineoverridevirtualnoexcept

Gets the current server connection status.

Returns

The current connection status.

Implements StormByte::Network::Endpoint.

---

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

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