Rebel Fork Framework
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:
Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Network (Context *context)
 Construct.
 
 ~Network () override
 Destruct.
 
void HandleMessage (const SLNet::AddressOrGUID &source, int packetID, int msgID, const char *data, size_t numBytes)
 Handle an inbound message.
 
void NewConnectionEstablished (const SLNet::AddressOrGUID &connection)
 Handle a new client connection.
 
void ClientDisconnected (const SLNet::AddressOrGUID &connection)
 Handle a client disconnection.
 
void SetDiscoveryBeacon (const VariantMap &data)
 Set the data that will be used for a reply to attempts at host discovery on LAN/subnet.
 
void DiscoverHosts (unsigned port)
 Scan the LAN/subnet for available hosts.
 
void SetPassword (const ea::string &password)
 Set password for the client/server communcation.
 
void SetNATServerInfo (const ea::string &address, unsigned short port)
 Set NAT server information.
 
bool Connect (const ea::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, unsigned int maxConnections=128)
 Start a server on a port using UDP protocol. Return true if successful.
 
void StopServer ()
 Stop the server.
 
void StartNATClient ()
 Start NAT punchtrough client to allow remote connections.
 
const ea::string & GetGUID () const
 
void AttemptNATPunchtrough (const ea::string &guid, Scene *scene, const VariantMap &identity=Variant::emptyVariantMap)
 Attempt to connect to NAT 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 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 SetSimulatedLatency (int ms)
 
void SetSimulatedPacketLoss (float probability)
 
void SetSimulateServerEvents (bool enable)
 Test only. Set whether to send events as server.
 
void SetSimulateClientEvents (bool enable)
 Test only. Set whether to send events as client.
 
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.
 
SharedPtr< HttpRequestMakeHttpRequest (const ea::string &url, const ea::string &verb=EMPTY_STRING, const ea::vector< ea::string > &headers=ea::vector< ea::string >(), const ea::string &postData=EMPTY_STRING)
 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.
 
void BanAddress (const ea::string &address)
 Ban specific IP addresses.
 
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.
 
int GetSimulatedLatency () const
 
float GetSimulatedPacketLoss () 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.
 
ConnectionGetConnection (const SLNet::AddressOrGUID &connection) const
 Return a client or server connection by RakNet connection address, or null if none exist.
 
ConnectionGetServerConnection () 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.
 
- 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 TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
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 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.
 
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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &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 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () 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 HandleBeginFrame (StringHash eventType, VariantMap &eventData)
 Handle begin frame event.
 
void HandleRenderUpdate (StringHash eventType, VariantMap &eventData)
 Handle render update frame event.
 
void OnServerConnected (const SLNet::AddressOrGUID &address)
 Handle server connection.
 
void OnServerDisconnected (const SLNet::AddressOrGUID &address)
 Handle server disconnection.
 
void ConfigureNetworkSimulator ()
 Reconfigure network simulator parameters on all existing connections.
 
void HandleIncomingPacket (SLNet::Packet *packet, bool isServer)
 All incoming packages are handled here.
 
void SendNetworkUpdateEvent (StringHash eventType, bool isServer)
 

Static Private Member Functions

static unsigned long GetEndpointHash (const SLNet::AddressOrGUID &endpoint)
 Return hash of endpoint.
 

Private Attributes

SLNet::RakPeerInterface * rakPeer_
 SLikeNet peer instance for server connection.
 
SLNet::RakPeerInterface * rakPeerClient_
 SLikeNet peer instance for client connection.
 
SharedPtr< ConnectionserverConnection_
 Client's server connection.
 
ea::unordered_map< unsigned long, SharedPtr< Connection > > clientConnections_
 Server's client connections. Key is SLNet::AddressOrGUID hash.
 
ea::hash_set< StringHashallowedRemoteEvents_
 Allowed remote events.
 
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.
 
bool updateNow_ {}
 Whether the network will be updated on this frame.
 
ea::string packageCacheDir_
 Package cache directory.
 
bool isServer_
 Whether we started as server or not.
 
ea::string password_
 Server/Client password used for connecting.
 
Scenescene_
 Scene which will be used for NAT punchtrough connections.
 
VariantMap identity_
 Client identify for NAT punchtrough connections.
 
SLNet::SystemAddress * natPunchServerAddress_
 NAT punchtrough server information.
 
SLNet::NatPunchthroughClient * natPunchthroughServerClient_
 NAT punchtrough client for the server.
 
SLNet::NatPunchthroughClient * natPunchthroughClient_
 NAT punchtrough client for the client.
 
SLNet::RakNetGUID * remoteGUID_
 Remote GUID information.
 
ea::string guid_
 Local server GUID.
 
bool simulateServerEvents_ {}
 
bool simulateClientEvents_ {}
 
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 TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 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.

◆ GetGUID()

const ea::string& Urho3D::Network::GetGUID ( ) const
inline

Get local server GUID.

◆ 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.

◆ GetSimulatedLatency()

int Urho3D::Network::GetSimulatedLatency ( ) const
inline

Return simulated latency in milliseconds.

◆ GetSimulatedPacketLoss()

float Urho3D::Network::GetSimulatedPacketLoss ( ) const
inline

Return simulated packet loss probability.

◆ GetUpdateFps()

unsigned Urho3D::Network::GetUpdateFps ( ) const
inline

Return network update FPS.

◆ IsServerRunning()

bool Urho3D::Network::IsServerRunning ( ) const

Return whether the server is running.

◆ SetPackageCacheDir()

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

Set the package download cache directory.

◆ SetSimulatedLatency()

void Urho3D::Network::SetSimulatedLatency ( int  ms)

Set simulated latency in milliseconds. This adds a fixed delay before sending each packet.

◆ SetSimulatedPacketLoss()

void Urho3D::Network::SetSimulatedPacketLoss ( float  probability)

Set simulated packet loss probability between 0.0 - 1.0.

◆ SetUpdateFps()

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

Set network update FPS.

Member Data Documentation

◆ simulateServerEvents_

bool Urho3D::Network::simulateServerEvents_ {}
private

Used for testing only

◆ 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: