eng::INetworkClient Class Reference

Interface for the client network. More...

#include <INetworkClient.hpp>

Inheritance diagram for eng::INetworkClient:

Collaboration diagram for eng::INetworkClient:

Public Types
using	PacketHandler = std::function<void(const rnp::PacketHeader &, const std::vector<uint8_t> &)>

Public Member Functions
virtual	~INetworkClient ()=default
virtual void	connect (const std::string &host, uint16_t port)=0
virtual void	disconnect ()=0
virtual void	sendConnect (const std::string &playerName)=0
virtual void	sendConnectWithCaps (const std::string &playerName, std::uint32_t clientCaps)=0
virtual void	sendDisconnect ()=0
virtual void	sendDisconnect (rnp::DisconnectReason reason)=0
virtual void	sendPlayerInput (uint8_t direction, uint8_t shooting)=0
virtual void	sendPlayerInputAsEvent (std::uint16_t playerId, uint8_t direction, uint8_t shooting, uint32_t clientTimeMs)=0
virtual void	sendPing ()=0
virtual void	sendPing (std::uint32_t nonce, std::uint32_t sendTimeMs)=0
virtual void	sendAck (std::uint32_t cumulative, std::uint32_t ackBits)=0
virtual void	setPacketHandler (rnp::PacketType type, PacketHandler handler)=0
virtual void	setEventsHandler (std::function< void(const std::vector< rnp::EventRecord > &)> handler)=0
virtual std::uint32_t	getSessionId () const =0
virtual std::uint16_t	getServerTickRate () const =0
Public Member Functions inherited from utl::IPlugin
virtual	~IPlugin ()=default
virtual const std::string	getName () const =0
virtual PluginType	getType () const =0

Detailed Description

Interface for the client network.

Definition at line 25 of file INetworkClient.hpp.

Member Typedef Documentation

PacketHandler

using eng::INetworkClient::PacketHandler = std::function<void(const rnp::PacketHeader &, const std::vector<uint8_t> &)>

Definition at line 28 of file INetworkClient.hpp.

Constructor & Destructor Documentation

~INetworkClient()

virtual eng::INetworkClient::~INetworkClient ( )

virtualdefault

Member Function Documentation

connect()

virtual void eng::INetworkClient::connect ( const std::string & host, uint16_t port )

pure virtual

Implemented in eng::AsioClient.

disconnect()

virtual void eng::INetworkClient::disconnect ( )

pure virtual

Implemented in eng::AsioClient.

getServerTickRate()

virtual std::uint16_t eng::INetworkClient::getServerTickRate ( ) const

pure virtual

Implemented in eng::AsioClient.

getSessionId()

virtual std::uint32_t eng::INetworkClient::getSessionId ( ) const

pure virtual

Implemented in eng::AsioClient.

sendAck()

virtual void eng::INetworkClient::sendAck ( std::uint32_t cumulative, std::uint32_t ackBits )

pure virtual

Implemented in eng::AsioClient.

sendConnect()

virtual void eng::INetworkClient::sendConnect ( const std::string & playerName )

pure virtual

Implemented in eng::AsioClient.

sendConnectWithCaps()

virtual void eng::INetworkClient::sendConnectWithCaps ( const std::string & playerName, std::uint32_t clientCaps )

pure virtual

Implemented in eng::AsioClient.

sendDisconnect() [1/2]

virtual void eng::INetworkClient::sendDisconnect ( )

pure virtual

Implemented in eng::AsioClient.

sendDisconnect() [2/2]

virtual void eng::INetworkClient::sendDisconnect ( rnp::DisconnectReason reason )

pure virtual

Implemented in eng::AsioClient.

sendPing() [1/2]

virtual void eng::INetworkClient::sendPing ( )

pure virtual

Implemented in eng::AsioClient.

sendPing() [2/2]

virtual void eng::INetworkClient::sendPing ( std::uint32_t nonce, std::uint32_t sendTimeMs )

pure virtual

Implemented in eng::AsioClient.

sendPlayerInput()

virtual void eng::INetworkClient::sendPlayerInput ( uint8_t direction, uint8_t shooting )

pure virtual

Implemented in eng::AsioClient.

sendPlayerInputAsEvent()

virtual void eng::INetworkClient::sendPlayerInputAsEvent ( std::uint16_t playerId, uint8_t direction, uint8_t shooting, uint32_t clientTimeMs )

pure virtual

Implemented in eng::AsioClient.

setEventsHandler()

virtual void eng::INetworkClient::setEventsHandler ( std::function< void(const std::vector< rnp::EventRecord > &)> handler )

pure virtual

Implemented in eng::AsioClient.

setPacketHandler()

virtual void eng::INetworkClient::setPacketHandler ( rnp::PacketType type, PacketHandler handler )

pure virtual

Implemented in eng::AsioClient.

---

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

• /home/runner/work/R-Type/R-Type/modules/Interfaces/include/Interfaces/INetworkClient.hpp