Urho3D::Network Class Reference

Network subsystem. Provides network update scheduling and replication events. More...

#include <Urho3D/Network/Network.h>

Inheritance diagram for Urho3D::Network:

Public Member Functions
	Network (Context *context)
	Construct.
	~Network () override
	Destruct.
SharedPtr< NetworkConnection >	CreateConnection (StringHash type=StringHash::Empty)
	Create a network connection of the specified type.
SharedPtr< NetworkServer >	CreateServer (StringHash type=StringHash::Empty)
	Create a network server of the specified type.
void	SetUpdateFps (unsigned fps)
unsigned	GetUpdateFps () const
float	GetUpdateOvertime () const
	Return the amount of time that happened after fixed-time network update.
bool	IsUpdateNow () const
	Return whether the network is updated on this frame.
bool	HasActiveResources () const
	Return whether any server or connection teardown is in progress.
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.
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.

Protected Member Functions
void	OnConnectionDisconnecting (NetworkConnection *connection)
	Called by NetworkConnection::Disconnect to notify teardown has started.
void	OnServerStopping (NetworkServer *server)
	Called by NetworkServer::Stop implementation to notify teardown has started.

Private Member Functions
	URHO3D_OBJECT (Network, Object)
void	SendNetworkUpdateEvent (StringHash eventType, bool isServer)
void	HandleBeginFrame (VariantMap &eventData)
void	HandleRenderUpdate (VariantMap &eventData)
void	HandleClientDisconnected (VariantMap &eventData)
void	HandleServerClientDisconnected (VariantMap &eventData)

Private Attributes
float	updateInterval_ = 1.0f / updateFps_
float	updateAcc_ = 0.0f
	Update time accumulator.
bool	updateNow_ {}
	Whether the network will be updated on this frame.
ea::hash_set< SharedPtr< NetworkServer > >	stoppingServers_
	Servers in teardown — held by shared ptr until all their connections disconnect.
ea::hash_set< SharedPtr< NetworkConnection > >	disconnectingConnections_
	Connections in teardown — held by shared ptr until fully disconnected.
unsigned	updateFps_ {30}

Friends
class	NetworkConnection
class	NetworkServer

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. Provides network update scheduling and replication events.

Member Function Documentation

GetUpdateFps()

unsigned Urho3D::Network::GetUpdateFps ( ) const

inline

Return network update FPS.

HandleBeginFrame()

void Urho3D::Network::HandleBeginFrame ( VariantMap &  eventData )

private

Event handlers.

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

updateInterval_

float Urho3D::Network::updateInterval_ = 1.0f / updateFps_

private

Update time interval.

---

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

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