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

#include <Urho3D/Network/Network.h>

Inheritance diagram for Urho3D::Network:
[legend]
Collaboration diagram for Urho3D::Network:
[legend]

Public Member Functions

 Network (Context *context)
 Construct.
 
virtual ~Network () override
 Destruct.
 
virtual void HandleMessage (kNet::MessageConnection *source, kNet::packet_id_t packetId, kNet::message_id_t msgId, const char *data, size_t numBytes) override
 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) override
 Compute the content ID for a message.
 
virtual void NewConnectionEstablished (kNet::MessageConnection *connection) override
 Handle a new client connection.
 
virtual void ClientDisconnected (kNet::MessageConnection *connection) override
 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< HttpRequestMakeHttpRequest (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.
 
ConnectionGetConnection (kNet::MessageConnection *connection) const
 Return a client or server connection by kNet MessageConnection, or null if none exist.
 
ConnectionGetServerConnection () 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 StringGetPackageCacheDir () 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 () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () 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.
 
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 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 SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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.
 
VariantMapGetEventDataMap () 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, Args...args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
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.
 
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.
 
RefCountRefCountPtr ()
 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

UniquePtr< kNet::Network > network_
 kNet instance.
 
SharedPtr< ConnectionserverConnection_
 Client's server connection.
 
HashMap
< kNet::MessageConnection
*, SharedPtr< Connection > > 
clientConnections_
 Server's client connections.
 
HashSet< StringHashallowedRemoteEvents_
 Allowed remote events.
 
HashSet< StringHashblacklistedRemoteEvents_
 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 TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 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