Urho3D::NetworkConnection Class Reference

Inheritance diagram for Urho3D::NetworkConnection:

Public Member Functions
	NetworkConnection (Context *context)
virtual bool	Connect (const URL &url)=0
virtual void	Disconnect ()
virtual unsigned	GetMaxMessageSize () const
	Return maximum size of raw network message.
virtual bool	SendData (ConstByteSpan data, PacketTypeFlags type=PacketType::ReliableOrdered)
	Sends data as-is via underlying transport. Data may be copied and sent asynchronously.
virtual bool	SendMessage (NetworkMessageId messageId, ConstByteSpan data, PacketTypeFlags type=PacketType::ReliableOrdered, ea::string_view debugInfo={})
	Sends network message. Data may be copied and sent asynchronously.
unsigned	GetMaxPayloadSize () const
	Return maximum size of network message payload.
const ea::string &	GetAddress () const
	Result may be empty, when connection is not NetworkConnectionState::Connected.
unsigned short	GetPort () const
NetworkConnectionState	GetState () const
	Return current state of the connection.
bool	IsConnected () const
	Return whether the connection is currently connected.
bool	IsDisconnected () const
	Return whether the connection is currently disconnected.
bool	GetProcessDataOnMainThread () const
	Return whether callbacks are invoked on the main thread.
void	SetProcessDataOnMainThread (bool enable)
	Set whether callbacks are invoked on the main thread.
NetworkServer *	GetServer () const
	Return server that owns this connection, if any.
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 () const
int	ReleaseRef () const
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 Attributes
Signal< void(), NetworkConnection >	OnConnected
Signal< void(), NetworkConnection >	OnDisconnected
Signal< void(ConstByteSpan data, bool &isHandled), NetworkConnection >	OnDataReceived
Signal< void(NetworkMessageId messageId, ConstByteSpan messagePayload, bool &isHandled), NetworkConnection >	OnMessageReceived
Signal< void(ConstByteSpan data, PacketTypeFlags, bool &isHandled), NetworkConnection >	OnSendData
Signal< void(NetworkMessageId messageId, ConstByteSpan messagePayload, PacketTypeFlags, ea::string_view debugInfo, bool &isHandled), NetworkConnection >	OnSendMessage

Protected Member Functions
void	NotifyDisconnecting ()
	Notify Network subsystem that teardown has started.
void	SetServer (NetworkServer *server)
	Set server that owns this connection.
virtual void	HandleConnected ()
virtual void	HandleDisconnected ()
virtual bool	HandleDataReceived (ConstByteSpan message)
virtual bool	HandleMessageReceived (NetworkMessageId messageId, ConstByteSpan message)
void	DispatchConnected ()
	Dispatch connection callback from transport implementation.
void	DispatchDisconnected ()
	Dispatch disconnection callback from transport implementation.
void	DispatchDataReceived (ConstByteSpan message)
	Dispatch data callback from transport implementation.
void	DispatchMessageReceived (NetworkMessageId messageId, ConstByteSpan message)
	Dispatch message callback from transport implementation.

Protected Attributes
NetworkConnectionState	state_ = NetworkConnectionState::Disconnected
ea::string	address_ = ""
unsigned short	port_ = 0
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (NetworkConnection, Object)
void	QueueIncomingPacket (ConstByteSpan message)
void	ProcessQueuedPackets ()

Private Attributes
VectorBuffer	outgoing_
ea::string	debugInfo_
std::atomic< bool >	processDataOnMainThread_ = true
WeakPtr< NetworkServer >	server_
Mutex	mutex_ {}
ea::vector< VectorBuffer >	incoming_
ea::vector< VectorBuffer >	incomingBack_
ea::vector< VectorBuffer >	buffers_

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Member Function Documentation

Connect()

virtual bool Urho3D::NetworkConnection::Connect ( const URL &  url )

pure virtual

Returns true, if connection initialization has started. Connection may still be unusable at the time this method returns.

Implemented in Urho3D::DataChannelConnection.

Disconnect()

void Urho3D::NetworkConnection::Disconnect ( )

virtual

Initializes a disconnection. Connection is no longer usable when this method returns, even though it may still remain connected for a short while.

Reimplemented in Urho3D::DataChannelConnection.

GetMaxMessageSize()

unsigned Urho3D::NetworkConnection::GetMaxMessageSize ( ) const

virtual

Return maximum size of raw network message.

Reimplemented in Urho3D::DataChannelConnection.

GetPort()

unsigned short Urho3D::NetworkConnection::GetPort ( ) const

inline

Result may be 0, when connection is not NetworkConnectionState::Connected or when result is not applicable to the underlying transport.

HandleConnected()

void Urho3D::NetworkConnection::HandleConnected ( )

protectedvirtual

Called once, when connection is fully set up and data is ready to be sent and received. Is called from the main thread.

HandleDataReceived()

bool Urho3D::NetworkConnection::HandleDataReceived ( ConstByteSpan  message )

protectedvirtual

Called when a new data is received. May be called from non-main thread depending on configuration. Returns true when the message was processed and should not be passed to other handlers.

HandleDisconnected()

void Urho3D::NetworkConnection::HandleDisconnected ( )

protectedvirtual

Called once, when connection disconnect was initiated (only if OnConnected was also called). Is called from the main thread.

HandleMessageReceived()

virtual bool Urho3D::NetworkConnection::HandleMessageReceived ( NetworkMessageId  messageId, ConstByteSpan  message  )

inlineprotectedvirtual

Called when a new network message is received. May be called from non-main thread. Returns true when the message was processed and should not be passed to other handlers.

SendData()

bool Urho3D::NetworkConnection::SendData ( ConstByteSpan  data, PacketTypeFlags  type = PacketType::ReliableOrdered  )

virtual

Sends data as-is via underlying transport. Data may be copied and sent asynchronously.

Reimplemented in Urho3D::DataChannelConnection.

---

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

• Urho3D/Network/NetworkConnection.h
• Urho3D/Network/NetworkConnection.cpp