Urho3D::Network Class Reference

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

#include <Urho3D/Network/Network.h>

Inheritance diagram for Urho3D::Network:

Collaboration diagram for Urho3D::Network:

Public Member Functions
	Network (Context *context)
	Construct.
	~Network ()
	Destruct.
virtual void	HandleMessage (kNet::MessageConnection *source, kNet::packet_id_t packetId, kNet::message_id_t msgId, const char *data, size_t numBytes)
	Handle a kNet message from either a client or the server.
virtual u32	ComputeContentID (kNet::message_id_t msgId, const char *data, size_t numBytes)
	Compute the content ID for a message.
virtual void	NewConnectionEstablished (kNet::MessageConnection *connection)
	Handle a new client connection.
virtual void	ClientDisconnected (kNet::MessageConnection *connection)
	Handle a client disconnection.
bool	Connect (const String &address, unsigned short port, 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 (unsigned short port)
	Start a server on a port using UDP protocol. Return true if successful.
void	StopServer ()
	Stop the server.
void	BroadcastMessage (int msgID, bool reliable, bool inOrder, const VectorBuffer &msg, unsigned contentID=0)
	Broadcast a message with content ID to all client connections.
void	BroadcastMessage (int msgID, bool reliable, bool inOrder, const unsigned char *data, unsigned numBytes, unsigned contentID=0)
	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	BroadcastRemoteEvent (Node *node, StringHash eventType, bool inOrder, const VariantMap &eventData=Variant::emptyVariantMap)
	Broadcast a remote event with the specified node as a sender. Is sent to all client connections in the node's scene.
void	SetUpdateFps (int fps)
	Set network update FPS.
void	SetSimulatedLatency (int ms)
	Set simulated latency in milliseconds. This adds a fixed delay before sending each packet.
void	SetSimulatedPacketLoss (float probability)
	Set simulated packet loss probability between 0.0 - 1.0.
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 String &path)
	Set the package download cache directory.
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.
SharedPtr< HttpRequest >	MakeHttpRequest (const String &url, const String &verb=String::EMPTY, const Vector< String > &headers=Vector< String >(), const String &postData=String::EMPTY)
	Perform an HTTP request to the specified URL. Empty verb defaults to a GET request. Return a request object which can be used to read the response data.
int	GetUpdateFps () const
	Return network update FPS.
int	GetSimulatedLatency () const
	Return simulated latency in milliseconds.
float	GetSimulatedPacketLoss () const
	Return simulated packet loss probability.
Connection *	GetConnection (kNet::MessageConnection *connection) const
	Return a client or server connection by kNet MessageConnection, or null if none exist.
Connection *	GetServerConnection () const
	Return the connection to the server. Null if not connected.
Vector< SharedPtr< Connection > >	GetClientConnections () const
	Return all client connections.
bool	IsServerRunning () const
	Return whether the server is running.
bool	CheckRemoteEvent (StringHash eventType) const
	Return whether a remote event is allowed to be received.
const String &	GetPackageCacheDir () const
	Return the package download cache directory.
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.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *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 PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and 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 String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
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.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	URHO3D_OBJECT (Network, Object)
void	HandleBeginFrame (StringHash eventType, VariantMap &eventData)
	Handle begin frame event.
void	HandleRenderUpdate (StringHash eventType, VariantMap &eventData)
	Handle render update frame event.
void	OnServerConnected ()
	Handle server connection.
void	OnServerDisconnected ()
	Handle server disconnection.
void	ConfigureNetworkSimulator ()
	Reconfigure network simulator parameters on all existing connections.

Private Attributes
kNet::Network *	network_
	kNet instance.
SharedPtr< Connection >	serverConnection_
	Client's server connection.
HashMap < kNet::MessageConnection *, SharedPtr< Connection > >	clientConnections_
	Server's client connections.
HashSet< StringHash >	allowedRemoteEvents_
	Allowed remote events.
HashSet< StringHash >	blacklistedRemoteEvents_
	Remote event fixed blacklist.
HashSet< Scene * >	networkScenes_
	Networked scenes.
int	updateFps_
	Update FPS.
int	simulatedLatency_
	Simulated latency (send delay) in milliseconds.
float	simulatedPacketLoss_
	Simulated packet loss probability between 0.0 - 1.0.
float	updateInterval_
	Update time interval.
float	updateAcc_
	Update time accumulator.
String	packageCacheDir_
	Package cache directory.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
static bool	IsTypeOf (StringHash type)
	Check current type is type of specified type.
static bool	IsTypeOf (const TypeInfo *typeInfo)
	Check current type is type of specified type.
template<typename T >
static bool	IsTypeOf ()
	Check current type is type of specified class.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

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

---

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

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