#include <Urho3D/Network/AbstractConnection.h>

Inheritance diagram for Urho3D::AbstractConnection:

Public Member Functions
	AbstractConnection (Context *context)

void	SetLogAllMessages (bool enabled)

bool	IsLogAllMessages () const

virtual void	SetMaxPacketSize (unsigned limit)
	Set maximum size of network packet. Connection transport may override this value.

virtual void	SendMessageInternal (NetworkMessageId messageId, const unsigned char *data, unsigned numBytes, PacketTypeFlags packetType=PacketType::ReliableOrdered)=0
	Send message to the other end of the connection.

virtual ea::string	ToString () const =0
	Return debug connection string for logging.

virtual bool	IsClockSynchronized () const =0
	Return whether the clock is synchronized between client and server.

virtual unsigned	RemoteToLocalTime (unsigned time) const =0
	Convert remote timestamp to local timestamp.

virtual unsigned	LocalToRemoteTime (unsigned time) const =0
	Convert local timestamp to remote timestamp.

virtual unsigned	GetLocalTime () const =0
	Return current local time.

virtual unsigned	GetLocalTimeOfLatestRoundtrip () const =0
	Return local time of last successful ping-pong roundtrip.

virtual unsigned	GetPing () const =0
	Return ping of the connection.


unsigned	GetMaxPacketSize () const

unsigned	GetMaxMessageSize () const


void	SendMessage (NetworkMessageId messageId, ConstByteSpan payload={}, PacketTypeFlags packetType=PacketType::ReliableOrdered, ea::string_view debugInfo={})

void	SendMessage (NetworkMessageId messageId, const VectorBuffer &msg, PacketTypeFlags packetType=PacketType::ReliableOrdered, ea::string_view debugInfo={})

void	LogMessagePayload (NetworkMessageId messageId, ea::string_view debugInfo) const

template<class T >
void	LogMessagePayload (NetworkMessageId messageId, const T &message) const

LogLevel	GetMessageLogLevel (NetworkMessageId messageId) const

VectorBuffer &	GetOutgoingMessageBuffer ()

ByteVector &	GetIncomingMessageBuffer ()

ea::string &	GetDebugInfoBuffer ()

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Public Member Functions inherited from Urho3D::IDFamily< AbstractConnection >
	IDFamily ()
	Construct.

	~IDFamily ()
	Destruct.

unsigned	GetObjectID () const
	Return unique object ID or 0 if not assigned.

void	AcquireObjectID ()
	Acquire unique object ID. Ignored if unique ID is already acquired.

void	ReleaseObjectID ()
	Release unique object ID. Ignored if unique ID is already released.

Protected Attributes
VectorBuffer	msg_

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (AbstractConnection, Object)

Private Attributes
unsigned	maxPacketSize_ {}

bool	logAllMessages_ {}

ByteVector	incomingMessageBuffer_

ea::string	debugInfoBuffer_

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Static Public Member Functions inherited from Urho3D::IDFamily< AbstractConnection >
static const unsigned	GetNextFreeObjectID ()
	Return upper bound of all used object IDs within family.

Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Detailed Description

Interface of connection to another host. Virtual for easier unit testing.

Member Function Documentation

◆ GetLocalTime()

virtual unsigned Urho3D::AbstractConnection::GetLocalTime ( ) const

pure virtual

Return current local time.

Implemented in Urho3D::Connection.

◆ GetLocalTimeOfLatestRoundtrip()

virtual unsigned Urho3D::AbstractConnection::GetLocalTimeOfLatestRoundtrip ( ) const

pure virtual

Return local time of last successful ping-pong roundtrip.

Implemented in Urho3D::Connection.

◆ GetMaxPacketSize()

unsigned Urho3D::AbstractConnection::GetMaxPacketSize ( ) const

Connection limits.

◆ GetPing()

virtual unsigned Urho3D::AbstractConnection::GetPing ( ) const

pure virtual

Return ping of the connection.

Implemented in Urho3D::Connection.

◆ IsClockSynchronized()

virtual bool Urho3D::AbstractConnection::IsClockSynchronized ( ) const

pure virtual

Return whether the clock is synchronized between client and server.

Implemented in Urho3D::Connection.

◆ LocalToRemoteTime()

virtual unsigned Urho3D::AbstractConnection::LocalToRemoteTime ( unsigned time ) const

pure virtual

Convert local timestamp to remote timestamp.

Implemented in Urho3D::Connection.

◆ RemoteToLocalTime()

virtual unsigned Urho3D::AbstractConnection::RemoteToLocalTime ( unsigned time ) const

pure virtual

Convert remote timestamp to local timestamp.

Implemented in Urho3D::Connection.

◆ SendMessage()

void Urho3D::AbstractConnection::SendMessage	(	NetworkMessageId	messageId,
		ConstByteSpan	payload = `{}`,
		PacketTypeFlags	packetType = `PacketType::ReliableOrdered`,
		ea::string_view	debugInfo = `{}`
	)

Syntax sugar for sending and receiving messages.

◆ SendMessageInternal()

virtual void Urho3D::AbstractConnection::SendMessageInternal	(	NetworkMessageId	messageId,
		const unsigned char *	data,
		unsigned	numBytes,
		PacketTypeFlags	packetType = `PacketType::ReliableOrdered`
	)

pure virtual

Send message to the other end of the connection.

Implemented in Urho3D::Connection.

◆ SetMaxPacketSize()

void Urho3D::AbstractConnection::SetMaxPacketSize ( unsigned limit )

virtual

Set maximum size of network packet. Connection transport may override this value.

Reimplemented in Urho3D::Connection.

◆ ToString()

virtual ea::string Urho3D::AbstractConnection::ToString ( ) const

pure virtual

Return debug connection string for logging.

Implemented in Urho3D::Connection.

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

Urho3D/Network/AbstractConnection.h
Urho3D/Network/AbstractConnection.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetLocalTime()

◆ GetLocalTimeOfLatestRoundtrip()

◆ GetMaxPacketSize()

◆ GetPing()

◆ IsClockSynchronized()

◆ LocalToRemoteTime()

◆ RemoteToLocalTime()

◆ SendMessage()

◆ SendMessageInternal()

◆ SetMaxPacketSize()

◆ ToString()