fm.liveswitch.CandidatePairState Enum Reference

The state of a candidate pair. More...

Public Member Functions
	CandidatePairState (int value)
int	getAssignedValue ()

Static Public Member Functions
	[static initializer]
static CandidatePairState	getByAssignedValue (int value)

Public Attributes
	New =(1)
	Indicates that the candidate pair has been formed, but connectivity checks have not yet started. More...
	Waiting =(2)
	Indicates that the connectivity check is ready for connectivity checks, but checks have not yet started. More...
	InProgress =(3)
	Indicates that connectivity checks are in progress. More...
	Succeeded =(4)
	Indicates that a connectivity check was successful. More...
	Failed =(5)
	Indicates that all connectivity checks have timed out or produced a failure response. More...
	Closed =(6)
	Indicates that connectivity checks have been stopped intentionally due to transport closure. More...
	ConnectivityLost =(7)
	Indicates that connectivity checks have succeeded in the past, but are currently not responding. More...

Detailed Description

The state of a candidate pair.

Constructor & Destructor Documentation

CandidatePairState()

fm.liveswitch.CandidatePairState.CandidatePairState

(

int

value

)

Member Function Documentation

[static initializer]()

fm.liveswitch.CandidatePairState.[static initializer]

static

getAssignedValue()

int fm.liveswitch.CandidatePairState.getAssignedValue

(

)

getByAssignedValue()

static CandidatePairState fm.liveswitch.CandidatePairState.getByAssignedValue ( int  value )

static

Member Data Documentation

Closed

fm.liveswitch.CandidatePairState.Closed =(6)

Indicates that connectivity checks have been stopped intentionally due to transport closure.

ConnectivityLost

fm.liveswitch.CandidatePairState.ConnectivityLost =(7)

Indicates that connectivity checks have succeeded in the past, but are currently not responding.

Failed

fm.liveswitch.CandidatePairState.Failed =(5)

Indicates that all connectivity checks have timed out or produced a failure response.

InProgress

fm.liveswitch.CandidatePairState.InProgress =(3)

Indicates that connectivity checks are in progress.

New

fm.liveswitch.CandidatePairState.New =(1)

Indicates that the candidate pair has been formed, but connectivity checks have not yet started.

Succeeded

fm.liveswitch.CandidatePairState.Succeeded =(4)

Indicates that a connectivity check was successful.

Waiting

fm.liveswitch.CandidatePairState.Waiting =(2)

Indicates that the connectivity check is ready for connectivity checks, but checks have not yet started.