Network subsystem. Manages client-server communications using the UDP protocol. More...

#include <Urho3D/Network/Network.h>

Inheritance diagram for Urho3D::Network:

Public Types
using	CreateServerCallback = ea::function< SharedPtr< NetworkServer >(Context *context)>

using	CreateConnectionCallback = ea::function< SharedPtr< NetworkConnection >(Context *context)>

Public Member Functions
	Network (Context *context)
	Construct.

	~Network () override
	Destruct.

bool	Connect (const URL &url, Scene *scene, const VariantMap &identity=Variant::emptyVariantMap)
	Connect to a server using UDP protocol. Return true if connection process successfully started.

void	Disconnect (int waitMSec=0)
	Disconnect the connection to the server. If wait time is non-zero, will block while waiting for disconnect to finish.

bool	StartServer (const URL &url, unsigned int maxConnections=128)
	Start a server on a port using UDP protocol. Return true if successful.

void	StopServer ()
	Stop the server.

void	BroadcastMessage (NetworkMessageId msgID, const VectorBuffer &msg, PacketTypeFlags packetType=PacketType::ReliableOrdered)
	Broadcast a message with content ID to all client connections.

void	BroadcastMessage (NetworkMessageId msgID, const unsigned char *data, unsigned numBytes, PacketTypeFlags packetType=PacketType::ReliableOrdered)
	Broadcast a message with content ID to all client connections.

void	BroadcastRemoteEvent (StringHash eventType, bool inOrder, const VariantMap &eventData=Variant::emptyVariantMap)
	Broadcast a remote event to all client connections.

void	BroadcastRemoteEvent (Scene *scene, StringHash eventType, bool inOrder, const VariantMap &eventData=Variant::emptyVariantMap)
	Broadcast a remote event to all client connections in a specific scene.

void	SetUpdateFps (unsigned fps)

void	SetPingIntervalMs (unsigned interval)
	Set interval of pings by server.

void	SetMaxPingIntervalMs (unsigned interval)
	Set max allowed ping by server.

void	SetClockBufferSize (unsigned size)
	Set number of clock synchronization samples used.

void	SetPingBufferSize (unsigned size)
	Set number of ping samples used.

void	RegisterRemoteEvent (StringHash eventType)
	Register a remote event as allowed to be received. There is also a fixed blacklist of events that can not be allowed in any case, such as ConsoleCommand.

void	UnregisterRemoteEvent (StringHash eventType)
	Unregister a remote event as allowed to received.

void	UnregisterAllRemoteEvents ()
	Unregister all remote events.

void	SetPackageCacheDir (const ea::string &path)

void	SendPackageToClients (Scene scene, PackageFile package)
	Trigger all client connections in the specified scene to download a package file from the server. Can be used to download additional resource packages when clients are already joined in the scene. The package must have been added as a requirement to the scene, or else the eventual download will fail.

unsigned	GetUpdateFps () const

unsigned	GetPingIntervalMs () const
	Return interval of pings by server.

unsigned	GetMaxPingIntervalMs () const
	Return max allowed ping by server.

unsigned	GetClockBufferSize () const
	Return number of clock synchronization samples used.

unsigned	GetPingBufferSize () const
	Return number of ping synchronization samples used.

float	GetUpdateOvertime () const
	Return the amount of time that happened after fixed-time network update.

void	SetTransportDefault ()
	Use the default transport (WebRTC)

void	SetTransportWebRTC ()
	Use the WebRTC transport.

void	SetTransportCustom (const CreateServerCallback &createServer, const CreateConnectionCallback &createConnection)
	Use a user defined transport.

bool	IsUpdateNow () const
	Return whether the network is updated on this frame.

Connection *	GetServerConnection () const

ea::vector< SharedPtr< Connection > >	GetClientConnections () const

bool	IsServerRunning () const

bool	CheckRemoteEvent (StringHash eventType) const
	Return whether a remote event is allowed to be received.

ea::string	GetDebugInfo () const
	Return aggregated debug info.

const ea::string &	GetPackageCacheDir () const

void	Update (float timeStep)
	Process incoming messages from connections. Called by HandleBeginFrame.

void	PostUpdate (float timeStep)
	Send outgoing messages after frame logic. Called by HandleRenderUpdate.


void	OnClientConnected (Connection *connection)

void	OnClientDisconnected (Connection *connection)

void	OnConnectedToServer (Connection *connection)

void	OnDisconnectedFromServer (Connection *connection)

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.

Private Member Functions
	URHO3D_OBJECT (Network, Object)

void	InitializeTransportCreateFuncs ()

void	SendNetworkUpdateEvent (StringHash eventType, bool isServer)


void	HandleApplicationExit ()

void	HandleBeginFrame (VariantMap &eventData)

void	HandleRenderUpdate (VariantMap &eventData)

Private Attributes
SharedPtr< Connection >	connectionToServer_
	Client's server connection.

ea::unordered_map< WeakPtr< NetworkConnection >, SharedPtr< Connection > >	clientConnections_
	Server's client connections.

ea::hash_set< StringHash >	allowedRemoteEvents_
	Allowed remote events.

float	updateInterval_ = 1.0f / updateFps_
	Update time interval.

float	updateAcc_ = 0.0f
	Update time accumulator.

bool	updateNow_ {}
	Whether the network will be updated on this frame.

ea::string	packageCacheDir_
	Package cache directory.

int	serverMaxConnections_ = 0
	Number of max allowed connections. Set by Network::StartServer.

SharedPtr< NetworkServer >	transportServer_
	Actual server, which accepts connections.

CreateServerCallback	createServer_

CreateConnectionCallback	createConnection_


unsigned	updateFps_ {30}

unsigned	pingIntervalMs_ {250}

unsigned	maxPingMs_ {10000}

unsigned	clockBufferSize_ {40}

unsigned	pingBufferSize_ {10}

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 {}

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

Detailed Description

Network subsystem. Manages client-server communications using the UDP protocol.

Member Function Documentation

◆ GetClientConnections()

ea::vector< SharedPtr< Connection > > Urho3D::Network::GetClientConnections ( ) const

Return all client connections.

◆ GetPackageCacheDir()

const ea::string& Urho3D::Network::GetPackageCacheDir ( ) const

inline

Return the package download cache directory.

◆ GetServerConnection()

Connection * Urho3D::Network::GetServerConnection ( ) const

Return the connection to the server. Null if not connected.

◆ GetUpdateFps()

unsigned Urho3D::Network::GetUpdateFps ( ) const

inline

Return network update FPS.

◆ HandleApplicationExit()

void Urho3D::Network::HandleApplicationExit ( )

private

Event handlers.

◆ IsServerRunning()

bool Urho3D::Network::IsServerRunning ( ) const

Return whether the server is running.

◆ OnClientConnected()

void Urho3D::Network::OnClientConnected ( Connection * connection )

Event handlers.

◆ SetPackageCacheDir()

void Urho3D::Network::SetPackageCacheDir ( const ea::string & path )

Set the package download cache directory.

◆ SetUpdateFps()

void Urho3D::Network::SetUpdateFps ( unsigned fps )

Set network update FPS.

Member Data Documentation

◆ updateFps_

unsigned Urho3D::Network::updateFps_ {30}

private

Properties that need connection reset to apply

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

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members