Documentation Index Fetch the complete documentation index at: https://mintlify.com/pion/ice/llms.txt
Use this file to discover all available pages before exploring further.
Overview The ConnectionState enum represents the state of an ICE connection as defined in RFC 5245. The agent transitions through these states as it establishes and maintains a peer-to-peer connection.
Type Definition States ConnectionStateNew const ConnectionStateNew ConnectionState = iota + 1
The ICE agent is gathering local candidates and has not started connectivity checks.
ConnectionStateChecking const ConnectionStateChecking
The agent has local and remote candidates and is attempting to find a working pair through connectivity checks.
ConnectionStateConnected const ConnectionStateConnected
The agent has found a working candidate pair, but may still be checking other pairs for better connectivity.
ConnectionStateCompleted const ConnectionStateCompleted
The agent has finished all connectivity checks and selected the best candidate pair.
In practice, most implementations transition directly from Connected to other states without using Completed.
ConnectionStateFailed const ConnectionStateFailed
The agent could not establish a connection. All candidate pairs failed connectivity checks or timed out.
ConnectionStateDisconnected const ConnectionStateDisconnected
The agent was previously connected but has lost connectivity. This is typically triggered after the disconnected timeout expires without receiving packets.
ConnectionStateClosed const ConnectionStateClosed
The agent has been closed and is no longer processing requests.
ConnectionStateUnknown const ConnectionStateUnknown ConnectionState = 0
Represents an unknown or uninitialized state.
Methods String func ( c ConnectionState ) String () string
Returns the string representation of the connection state.
Returns:
"New" for ConnectionStateNew"Checking" for ConnectionStateChecking"Connected" for ConnectionStateConnected"Completed" for ConnectionStateCompleted"Failed" for ConnectionStateFailed"Disconnected" for ConnectionStateDisconnected"Closed" for ConnectionStateClosed"Invalid" for unknown states
State Transitions Common Transitions:
New → Checking : When remote credentials are set and connectivity checks beginChecking → Connected : When a candidate pair succeedsConnected → Disconnected : When no packets received within DisconnectedTimeoutDisconnected → Connected : When connectivity is restoredDisconnected → Failed : When disconnected for longer than FailedTimeoutChecking → Failed : When all pairs fail or checking times outAny → Closed : When Close() or GracefulClose() is called
Usage Example Monitoring State
State-Based Logic
agent , _ := ice . NewAgentWithOptions ( ice . WithUrls ([] * stun . URI { stunURL }), ) // Register state change handler agent . OnConnectionStateChange ( func ( state ice . ConnectionState ) { log . Printf ( "Connection state changed: %s " , state . String ()) switch state { case ice . ConnectionStateConnected : log . Println ( "ICE connected!" ) case ice . ConnectionStateFailed : log . Println ( "ICE connection failed" ) case ice . ConnectionStateDisconnected : log . Println ( "ICE disconnected, attempting to reconnect..." ) case ice . ConnectionStateClosed : log . Println ( "ICE agent closed" ) } })
Timeout Configuration You can configure state transition timeouts:
agent , _ := ice . NewAgentWithOptions ( // Time before Connected → Disconnected ice . WithDisconnectedTimeout ( 5 * time . Second ), // Additional time before Disconnected → Failed ice . WithFailedTimeout ( 25 * time . Second ), )
Default Values:
DisconnectedTimeout : 5 secondsFailedTimeout : 25 seconds (after disconnected)
Setting a timeout to 0 disables that state transition.
