Network subsystem. Manages client-server communications using the UDP protocol. More...
#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Network/Network.h>
Inheritance diagram for Urho3D::Network:
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 String &password) |
| Set password for the client/server communcation. | |
| void | SetNATServerInfo (const String &address, unsigned short port) |
| Set NAT server information. | |
| 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, 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 String & | GetGUID () const |
| Get local server GUID. | |
| void | AttemptNATPunchtrough (const 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 byte *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. | |
| void | BanAddress (const String &address) |
| Ban specific IP addresses. | |
| 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 (const SLNet::AddressOrGUID &connection) const |
| Return a client or server connection by RakNet connection address, 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. | |
| ~Object () override | |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| Return type hash. More... | |
| virtual const String & | GetTypeName () const =0 |
| Return type name. More... | |
| 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. | |
| 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 Vector< 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. | |
| 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, 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. | |
| 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. | |
| 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. | |
| 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 (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. | |
Private Attributes | |
| SLNet::RakPeerInterface * | rakPeer_ |
| SLikeNet peer instance for server connection. | |
| SLNet::RakPeerInterface * | rakPeerClient_ |
| SLikeNet peer instance for client connection. | |
| SharedPtr< Connection > | serverConnection_ |
| Client's server connection. | |
| HashMap< SLNet::AddressOrGUID, 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. | |
| bool | isServer_ |
| Whether we started as server or not. | |
| String | password_ |
| Server/Client password used for connecting. | |
| Scene * | scene_ |
| 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. | |
| String | guid_ |
| Local server GUID. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
| 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:
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Network/Network.h
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Network/Network.cpp
