Photon.Realtime.RegionPinger Class Reference

Public Member Functions
	RegionPinger (Region region, Action< Region > onDoneCallback)
bool	Start ()
	Starts the ping routine for the assigned region. More...
string	GetResults ()

Static Public Member Functions
static string	ResolveHost (string hostName)
	Attempts to resolve a hostname into an IP string or returns empty string if that fails. More...

Public Attributes
int	CurrentAttempt = 0

Static Public Attributes
static int	Attempts = 5
static bool	IgnoreInitialAttempt = true
static int	MaxMilliseconsPerPing = 800
static int	PingWhenFailed = Attempts * MaxMilliseconsPerPing

Properties
bool	Done [get]

Constructor & Destructor Documentation

RegionPinger()

Photon.Realtime.RegionPinger.RegionPinger ( Region  region, Action< Region >  onDoneCallback  )

inline

Member Function Documentation

GetResults()

string Photon.Realtime.RegionPinger.GetResults ( )

inline

ResolveHost()

static string Photon.Realtime.RegionPinger.ResolveHost ( string  hostName )

inlinestatic

Attempts to resolve a hostname into an IP string or returns empty string if that fails.

To be compatible with most platforms, the address family is checked like this:
if (ipAddress.AddressFamily.ToString().Contains("6")) // ipv6...

Parameters

hostName

Hostname to resolve.

Returns

IP string or empty string if resolution fails

Start()

bool Photon.Realtime.RegionPinger.Start ( )

inline

Starts the ping routine for the assigned region.

Pinging runs in a ThreadPool worker item or (if needed) in a Thread. WebGL runs pinging on the Main Thread as coroutine.

Returns

Always true.

Member Data Documentation

Attempts

int Photon.Realtime.RegionPinger.Attempts = 5

static

CurrentAttempt

int Photon.Realtime.RegionPinger.CurrentAttempt = 0

IgnoreInitialAttempt

bool Photon.Realtime.RegionPinger.IgnoreInitialAttempt = true

static

MaxMilliseconsPerPing

int Photon.Realtime.RegionPinger.MaxMilliseconsPerPing = 800

static

PingWhenFailed

int Photon.Realtime.RegionPinger.PingWhenFailed = Attempts * MaxMilliseconsPerPing

static

Property Documentation

Done

bool Photon.Realtime.RegionPinger.Done

get

---

The documentation for this class was generated from the following file:

• D:/ExitGames/src/photon-sdk-dotnet-release-clean/PhotonLoadbalancingApi/RegionHandler.cs