Network code documentation for my turn-based game 1.0
All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Attributes | List of all members
ServerNetworkInterface Class Referenceabstract

ServerNetworkInterface is an interface to communicates with multiple clients. More...

#include <server_network_interface.h>

Inheritance diagram for ServerNetworkInterface:
ServerNetworkManager

Public Member Functions

 ServerNetworkInterface () noexcept=default
 
 ServerNetworkInterface (ServerNetworkInterface &&other) noexcept=default
 
ServerNetworkInterfaceoperator= (ServerNetworkInterface &&other) noexcept=default
 
 ServerNetworkInterface (const ServerNetworkInterface &other) noexcept=default
 
ServerNetworkInterfaceoperator= (const ServerNetworkInterface &other)=default
 
virtual ~ServerNetworkInterface () noexcept=default
 
virtual void SendPacket (sf::Packet *packet, Port client_id) noexcept=0
 
virtual void PollEvents () noexcept=0
 PollEvents is a pure virtual method which must poll the network events such as client connections/disconnections and client packets receiving.
 
void RegisterPacketReceivedCallback (const std::function< void(ClientPacket *client_packet)> &callback)
 
void RegisterClientDisconnectionCallback (const std::function< void(Port client_port)> &callback)
 

Protected Attributes

std::function< void(ClientPacket *packet_data) packet_received_callback_ )
 
std::function< void(Port client_port)> disconnect_callback_
 

Detailed Description

ServerNetworkInterface is an interface to communicates with multiple clients.

Constructor & Destructor Documentation

◆ ServerNetworkInterface() [1/3]

ServerNetworkInterface::ServerNetworkInterface ( )
defaultnoexcept

◆ ServerNetworkInterface() [2/3]

ServerNetworkInterface::ServerNetworkInterface ( ServerNetworkInterface && other)
defaultnoexcept

◆ ServerNetworkInterface() [3/3]

ServerNetworkInterface::ServerNetworkInterface ( const ServerNetworkInterface & other)
defaultnoexcept

◆ ~ServerNetworkInterface()

virtual ServerNetworkInterface::~ServerNetworkInterface ( )
virtualdefaultnoexcept

Member Function Documentation

◆ operator=() [1/2]

ServerNetworkInterface & ServerNetworkInterface::operator= ( const ServerNetworkInterface & other)
default

◆ operator=() [2/2]

ServerNetworkInterface & ServerNetworkInterface::operator= ( ServerNetworkInterface && other)
defaultnoexcept

◆ PollEvents()

virtual void ServerNetworkInterface::PollEvents ( )
pure virtualnoexcept

PollEvents is a pure virtual method which must poll the network events such as client connections/disconnections and client packets receiving.

Note
This method has to be overriden.

Implemented in ServerNetworkManager.

◆ RegisterClientDisconnectionCallback()

void ServerNetworkInterface::RegisterClientDisconnectionCallback ( const std::function< void(Port client_port)> & callback)
inline

◆ RegisterPacketReceivedCallback()

void ServerNetworkInterface::RegisterPacketReceivedCallback ( const std::function< void(ClientPacket *client_packet)> & callback)
inline

◆ SendPacket()

virtual void ServerNetworkInterface::SendPacket ( sf::Packet * packet,
Port client_id )
pure virtualnoexcept

Implemented in ServerNetworkManager.

Member Data Documentation

◆ disconnect_callback_

std::function<void(Port client_port)> ServerNetworkInterface::disconnect_callback_
protected

◆ packet_received_callback_

std::function<void(ClientPacket* packet_data) ServerNetworkInterface::packet_received_callback_)
protected

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