Photon Unity Networking 2
2.45
Provides methods to work with Photon's regions (Photon Cloud) and can be use to find the one with best ping. More...
Public Member Functions | |
| string | GetResults () |
| Provides a list of regions and their pings as string. More... | |
| void | SetRegions (OperationResponse opGetRegions) |
| Initializes the regions of this RegionHandler with values provided from the Name Server (as OperationResponse for OpGetRegions). More... | |
| RegionHandler (ushort masterServerPortOverride=0) | |
| Creates a new RegionHandler. More... | |
| bool | PingMinimumOfRegions (Action< RegionHandler > onCompleteCallback, string previousSummary) |
| Starts the process of pinging of all available regions. More... | |
| void | Abort () |
| Calling this will stop pinging the regions and suppress the onComplete callback. More... | |
Public Attributes | |
| int | BestRegionSummaryPingLimit = 90 |
| If the region from a previous BestRegionSummary now has a ping higher than this limit, all regions get pinged again to find a better. Default: 90ms. More... | |
Static Public Attributes | |
| static Type | PingImplementation |
| The implementation of PhotonPing to use for region pinging (Best Region detection). More... | |
Properties | |
| List< Region > | EnabledRegions [get, set] |
| A list of region names for the Photon Cloud. Set by the result of OpGetRegions(). More... | |
| Region | BestRegion [get] |
| When PingMinimumOfRegions was called and completed, the BestRegion is identified by best ping. More... | |
| string | SummaryToCache [get] |
| This value summarizes the results of pinging currently available regions (after PingMinimumOfRegions finished). More... | |
| bool | IsPinging [get] |
| True if the available regions are being pinged currently. More... | |
| bool | Aborted [get] |
| True if the pinging of regions is being aborted. More... | |
Provides methods to work with Photon's regions (Photon Cloud) and can be use to find the one with best ping.
When a client uses a Name Server to fetch the list of available regions, the LoadBalancingClient will create a RegionHandler and provide it via the OnRegionListReceived callback, as soon as the list is available. No pings were sent for Best Region selection yet.
Your logic can decide to either connect to one of those regional servers, or it may use PingMinimumOfRegions to test which region provides the best ping. Alternatively the client may be set to connect to the Best Region (lowest ping), one or more regions get pinged. Not all regions will be pinged. As soon as the results are final, the client will connect to the best region, so you can check the ping results when connected to the Master Server.
Regions gets pinged 5 times (RegionPinger.Attempts). Out of those, the worst rtt is discarded and the best will be counted two times for a weighted average.
Usually UDP will be used to ping the Master Servers. In WebGL, WSS is used instead.
It makes sense to make clients "sticky" to a region when one gets selected. This can be achieved by storing the SummaryToCache value, once pinging was done. When the client connects again, the previous SummaryToCache helps limiting the number of regions to ping. In best case, only the previously selected region gets re-pinged and if the current ping is not much worse, this one region is used again.
| RegionHandler | ( | ushort | masterServerPortOverride = 0 | ) |
Creates a new RegionHandler.
| masterServerPortOverride | If non-zero, this port will be used to ping Master Servers on. |
| void Abort | ( | ) |
Calling this will stop pinging the regions and suppress the onComplete callback.
| string GetResults | ( | ) |
Provides a list of regions and their pings as string.
| bool PingMinimumOfRegions | ( | Action< RegionHandler > | onCompleteCallback, |
| string | previousSummary | ||
| ) |
Starts the process of pinging of all available regions.
| onCompleteCallback | Provide a method to call when all ping results are available. Aborting the pings will also cancel the callback. |
| previousSummary | A BestRegionSummary from an earlier RegionHandler run. This makes a selected best region "sticky" and keeps ping times lower. |
| void SetRegions | ( | OperationResponse | opGetRegions | ) |
Initializes the regions of this RegionHandler with values provided from the Name Server (as OperationResponse for OpGetRegions).
| int BestRegionSummaryPingLimit = 90 |
If the region from a previous BestRegionSummary now has a ping higher than this limit, all regions get pinged again to find a better. Default: 90ms.
Pinging all regions takes time, which is why a BestRegionSummary gets stored. If that is available, the Best Region becomes sticky and is used again. This limit introduces an exception: Should the pre-defined best region have a ping worse than this, all regions are considered.
|
static |
The implementation of PhotonPing to use for region pinging (Best Region detection).
Defaults to null, which means the Type is set automatically.
|
get |
True if the pinging of regions is being aborted.
|
get |
When PingMinimumOfRegions was called and completed, the BestRegion is identified by best ping.
|
getset |
A list of region names for the Photon Cloud. Set by the result of OpGetRegions().
Implement ILoadBalancingCallbacks and register for the callbacks to get OnRegionListReceived(RegionHandler regionHandler). You can also put a "case OperationCode.GetRegions:" into your OnOperationResponse method to notice when the result is available.
|
get |
True if the available regions are being pinged currently.
|
get |
This value summarizes the results of pinging currently available regions (after PingMinimumOfRegions finished).
This value should be stored in the client by the game logic. When connecting again, use it as previous summary to speed up pinging regions and to make the best region sticky for the client.