ICE コネクションステート機能¶
概要¶
ICE コネクションステート機能は Sora に ICE コネクションによる状態管理を持たせた機能です。
前提¶
この機能はクライアント側が意識する必要はありません。
挙動¶
Sora は WebRTC が確立した後に TURN 上で ICE コネクションステートを更新し続けます。
ステートの更新には STUN Binding-Request と STUN Binding-Sucess を利用します。
Sora は 2.5 秒間隔で
STUN Binding-Requestをクライアントへ送りますSTUN Binding-Successが 2.5 秒以内に一度も返ってこない場合、状態をconnectedからconnectingへ遷移します
状態が
connectingへ遷移した場合、 Sora は 1 秒間隔でSTUN Binding-Requestをクライアントへ送りますSTUN Binding-Successが 5 秒以内に一度も返ってこない場合、状態を connecting から disocnnected へ遷移しますこの 5 秒は
sora.confにてice_connection_state_disconnected_timeoutで変更可能です
状態が
disocnnectedに遷移した場合、 Sora は 50 ミリ秒間隔でSTUN Binding-Requestをクライアントへ送りますSTUN Binding-Successが 10 秒以内に一度も返ってこない場合、状態をdisconnectedからfailedへ遷移しますこの 10 秒は
sora.confにてice_connection_state_failed_timeoutで変更可能ですこのタイミングで
sora.logにwarningとしてICE-CONNECTION-STATE-DISCONNECTEDが出力されます
状態が
failedに遷移した場合、Sora はクライアントの接続を切断しますこのタイミングで
sora.logにerrorとしてICE-CONNECTION-STATE-FAILEDが出力されます
設定¶
ICE コネクションステート機能は無効にすることはできません。
ただし、切断や失敗までの判定時間を sora.conf にてデフォルト値から変更することが可能です。
ice_connection_state_disconnected_timeout¶
この値は Sora が ICE コネクションステートを disconnected へと遷移する際にクライアントからの応答を待つ時間です。
デフォルトでは 5 s が設定されています。
ice_connection_state_failed_timeout¶
この値は Sora が ICE コネクションステートを failed へと遷移する際にクライアントからの応答を待つ時間です。
デフォルトでは 10 s が設定されています。
シーケンス図¶
重要
図のタイムアウト値はデフォルト値を採用しています。
connected¶
正常な接続状態である connected を継続しているシーケンス図です。
connected -> connecting¶
正常な接続状態である connected から一時的に反応が無く connecting 状態へ切り替わるシーケンス図です。
connecting -> disconnected¶
一時的に反応が無い connecting の状態が続いたため、 切断判断をするために短い間隔で疎通パケットを送信する disconnected 状態へ切り替わるシーケンス図です。
disconnected -> failed¶
切断判断をするため短い間隔で疎通パケットを送り続けたが、反応が無かったため failed へと切り替わるシーケンス図です。
disconnected -> connecting -> connected¶
一定時間、不通になっていたため状態が disconnected になっていましたが、 connecting を経て connected まで状態が戻るシーケンス図です。