RakNet::UDPProxyCoordinator Class Reference
[NatPunchthrough]
Middleman between UDPProxyServer and UDPProxyClient, maintaining a list of UDPProxyServer, and managing state for clients to find an available forwarding server.
More...
#include <UDPProxyCoordinator.h>
Public Member Functions | |
| void | SetRemoteLoginPassword (RakNet::RakString password) |
| virtual void | Update (void) |
| Update is called every time a packet is checked for . | |
| virtual PluginReceiveResult | OnReceive (Packet *packet) |
| virtual void | OnClosedConnection (const SystemAddress &systemAddress, RakNetGUID rakNetGUID, PI2_LostConnectionReason lostConnectionReason) |
Detailed Description
Middleman between UDPProxyServer and UDPProxyClient, maintaining a list of UDPProxyServer, and managing state for clients to find an available forwarding server.When NAT Punchthrough fails, it is possible to use a non-NAT system to forward messages from us to the recipient, and vice-versa The class to forward messages is UDPForwarder, and it is triggered over the network via the UDPProxyServer plugin. The UDPProxyClient connects to UDPProxyCoordinator to get a list of servers running UDPProxyServer, and the coordinator will relay our forwarding request
Member Function Documentation
| virtual void RakNet::UDPProxyCoordinator::OnClosedConnection | ( | const SystemAddress & | systemAddress, | |
| RakNetGUID | rakNetGUID, | |||
| PI2_LostConnectionReason | lostConnectionReason | |||
| ) | [virtual] |
Called when a connection is dropped because the user called RakPeer::CloseConnection() for a particular system
- Parameters:
-
[in] systemAddress The system whose connection was closed [in] rakNetGuid The guid of the specified system [in] lostConnectionReason How the connection was closed: manually, connection lost, or notification of disconnection
Reimplemented from RakNet::PluginInterface2.
| virtual PluginReceiveResult RakNet::UDPProxyCoordinator::OnReceive | ( | Packet * | packet | ) | [virtual] |
OnReceive is called for every packet.
- Parameters:
-
[in] packet the packet that is being returned to the user
- Returns:
- True to allow the game and other plugins to get this message, false to absorb it
Reimplemented from RakNet::PluginInterface2.
| void RakNet::UDPProxyCoordinator::SetRemoteLoginPassword | ( | RakNet::RakString | password | ) |
For UDPProxyServers logging in remotely, they must pass a password to UDPProxyServer::LoginToCoordinator(). It must match the password set here. If no password is set, they cannot login remotely. By default, no password is set
The documentation for this class was generated from the following file:
- d:/temp/RakNet_PC/Source/UDPProxyCoordinator.h
