Amazon Kinesis Webrtc C SDK
IceAgentStateMachine.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ICE_AGENT_STATE_NONE   ((UINT64) 0)
 
#define ICE_AGENT_STATE_NEW   ((UINT64) (1 << 0))
 
#define ICE_AGENT_STATE_CHECK_CONNECTION   ((UINT64) (1 << 1))
 
#define ICE_AGENT_STATE_CONNECTED   ((UINT64) (1 << 2))
 
#define ICE_AGENT_STATE_NOMINATING   ((UINT64) (1 << 3))
 
#define ICE_AGENT_STATE_READY   ((UINT64) (1 << 4))
 
#define ICE_AGENT_STATE_DISCONNECTED   ((UINT64) (1 << 5))
 
#define ICE_AGENT_STATE_FAILED   ((UINT64) (1 << 6))
 
#define ICE_AGENT_STATE_NONE_STR   (PCHAR) "ICE_AGENT_STATE_NONE"
 
#define ICE_AGENT_STATE_NEW_STR   (PCHAR) "ICE_AGENT_STATE_NEW"
 
#define ICE_AGENT_STATE_CHECK_CONNECTION_STR   (PCHAR) "ICE_AGENT_STATE_CHECK_CONNECTION"
 
#define ICE_AGENT_STATE_CONNECTED_STR   (PCHAR) "ICE_AGENT_STATE_CONNECTED"
 
#define ICE_AGENT_STATE_NOMINATING_STR   (PCHAR) "ICE_AGENT_STATE_NOMINATING"
 
#define ICE_AGENT_STATE_READY_STR   (PCHAR) "ICE_AGENT_STATE_READY"
 
#define ICE_AGENT_STATE_DISCONNECTED_STR   (PCHAR) "ICE_AGENT_STATE_DISCONNECTED"
 
#define ICE_AGENT_STATE_FAILED_STR   (PCHAR) "ICE_AGENT_STATE_FAILED"
 

Functions

STATUS stepIceAgentStateMachine (PIceAgent)
 
STATUS acceptIceAgentMachineState (PIceAgent, UINT64)
 
STATUS iceAgentStateMachineCheckDisconnection (PIceAgent, PUINT64)
 
PCHAR iceAgentStateToString (UINT64)
 
STATUS fromNewIceAgentState (UINT64, PUINT64)
 
STATUS executeNewIceAgentState (UINT64, UINT64)
 
STATUS fromCheckConnectionIceAgentState (UINT64, PUINT64)
 
STATUS executeCheckConnectionIceAgentState (UINT64, UINT64)
 
STATUS fromConnectedIceAgentState (UINT64, PUINT64)
 
STATUS executeConnectedIceAgentState (UINT64, UINT64)
 
STATUS fromNominatingIceAgentState (UINT64, PUINT64)
 
STATUS executeNominatingIceAgentState (UINT64, UINT64)
 
STATUS fromReadyIceAgentState (UINT64, PUINT64)
 
STATUS executeReadyIceAgentState (UINT64, UINT64)
 
STATUS fromDisconnectedIceAgentState (UINT64, PUINT64)
 
STATUS executeDisconnectedIceAgentState (UINT64, UINT64)
 
STATUS fromFailedIceAgentState (UINT64, PUINT64)
 
STATUS executeFailedIceAgentState (UINT64, UINT64)
 

Macro Definition Documentation

◆ ICE_AGENT_STATE_CHECK_CONNECTION

#define ICE_AGENT_STATE_CHECK_CONNECTION   ((UINT64) (1 << 1))

◆ ICE_AGENT_STATE_CHECK_CONNECTION_STR

#define ICE_AGENT_STATE_CHECK_CONNECTION_STR   (PCHAR) "ICE_AGENT_STATE_CHECK_CONNECTION"

◆ ICE_AGENT_STATE_CONNECTED

#define ICE_AGENT_STATE_CONNECTED   ((UINT64) (1 << 2))

◆ ICE_AGENT_STATE_CONNECTED_STR

#define ICE_AGENT_STATE_CONNECTED_STR   (PCHAR) "ICE_AGENT_STATE_CONNECTED"

◆ ICE_AGENT_STATE_DISCONNECTED

#define ICE_AGENT_STATE_DISCONNECTED   ((UINT64) (1 << 5))

◆ ICE_AGENT_STATE_DISCONNECTED_STR

#define ICE_AGENT_STATE_DISCONNECTED_STR   (PCHAR) "ICE_AGENT_STATE_DISCONNECTED"

◆ ICE_AGENT_STATE_FAILED

#define ICE_AGENT_STATE_FAILED   ((UINT64) (1 << 6))

◆ ICE_AGENT_STATE_FAILED_STR

#define ICE_AGENT_STATE_FAILED_STR   (PCHAR) "ICE_AGENT_STATE_FAILED"

◆ ICE_AGENT_STATE_NEW

#define ICE_AGENT_STATE_NEW   ((UINT64) (1 << 0))

◆ ICE_AGENT_STATE_NEW_STR

#define ICE_AGENT_STATE_NEW_STR   (PCHAR) "ICE_AGENT_STATE_NEW"

◆ ICE_AGENT_STATE_NOMINATING

#define ICE_AGENT_STATE_NOMINATING   ((UINT64) (1 << 3))

◆ ICE_AGENT_STATE_NOMINATING_STR

#define ICE_AGENT_STATE_NOMINATING_STR   (PCHAR) "ICE_AGENT_STATE_NOMINATING"

◆ ICE_AGENT_STATE_NONE

#define ICE_AGENT_STATE_NONE   ((UINT64) 0)

Ice states definitions

ICE_AGENT_STATE_NONE: Dummy state ICE_AGENT_STATE_NEW: State at creation ICE_AGENT_STATE_CHECK_CONNECTION: Checking candidate pair connectivity ICE_AGENT_STATE_CONNECTED: At least one working candidate pair ICE_AGENT_STATE_NOMINATING: Waiting for connectivity check to succeed for the nominated cadidate pair ICE_AGENT_STATE_READY: Selected candidate pair is now final ICE_AGENT_STATE_DISCONNECTED: Lost connection after ICE_AGENT_STATE_READY ICE_AGENT_STATE_FAILED: Terminal state with an error stored in iceAgentStatus

◆ ICE_AGENT_STATE_NONE_STR

#define ICE_AGENT_STATE_NONE_STR   (PCHAR) "ICE_AGENT_STATE_NONE"

◆ ICE_AGENT_STATE_READY

#define ICE_AGENT_STATE_READY   ((UINT64) (1 << 4))

◆ ICE_AGENT_STATE_READY_STR

#define ICE_AGENT_STATE_READY_STR   (PCHAR) "ICE_AGENT_STATE_READY"

Function Documentation

◆ acceptIceAgentMachineState()

STATUS acceptIceAgentMachineState ( PIceAgent  pIceAgent,
UINT64  state 
)

◆ executeCheckConnectionIceAgentState()

STATUS executeCheckConnectionIceAgentState ( UINT64  customData,
UINT64  time 
)
Here is the call graph for this function:

◆ executeConnectedIceAgentState()

STATUS executeConnectedIceAgentState ( UINT64  customData,
UINT64  time 
)
Here is the call graph for this function:

◆ executeDisconnectedIceAgentState()

STATUS executeDisconnectedIceAgentState ( UINT64  customData,
UINT64  time 
)
Here is the call graph for this function:

◆ executeFailedIceAgentState()

STATUS executeFailedIceAgentState ( UINT64  customData,
UINT64  time 
)

◆ executeNewIceAgentState()

STATUS executeNewIceAgentState ( UINT64  customData,
UINT64  time 
)

◆ executeNominatingIceAgentState()

STATUS executeNominatingIceAgentState ( UINT64  customData,
UINT64  time 
)
Here is the call graph for this function:

◆ executeReadyIceAgentState()

STATUS executeReadyIceAgentState ( UINT64  customData,
UINT64  time 
)
Here is the call graph for this function:

◆ fromCheckConnectionIceAgentState()

STATUS fromCheckConnectionIceAgentState ( UINT64  customData,
PUINT64  pState 
)

◆ fromConnectedIceAgentState()

STATUS fromConnectedIceAgentState ( UINT64  customData,
PUINT64  pState 
)

◆ fromDisconnectedIceAgentState()

STATUS fromDisconnectedIceAgentState ( UINT64  customData,
PUINT64  pState 
)

◆ fromFailedIceAgentState()

STATUS fromFailedIceAgentState ( UINT64  customData,
PUINT64  pState 
)

◆ fromNewIceAgentState()

STATUS fromNewIceAgentState ( UINT64  customData,
PUINT64  pState 
)

Ice agent state machine callbacks

◆ fromNominatingIceAgentState()

STATUS fromNominatingIceAgentState ( UINT64  customData,
PUINT64  pState 
)

◆ fromReadyIceAgentState()

STATUS fromReadyIceAgentState ( UINT64  customData,
PUINT64  pState 
)
Here is the call graph for this function:

◆ iceAgentStateMachineCheckDisconnection()

STATUS iceAgentStateMachineCheckDisconnection ( PIceAgent  pIceAgent,
PUINT64  pNextState 
)
Here is the caller graph for this function:

◆ iceAgentStateToString()

PCHAR iceAgentStateToString ( UINT64  state)
Here is the caller graph for this function:

◆ stepIceAgentStateMachine()

STATUS stepIceAgentStateMachine ( PIceAgent  pIceAgent)
Here is the call graph for this function:
Here is the caller graph for this function: