コネクション ID の導入¶
コネクション ID の導入について不明点がある場合はサポートまでお気軽にお問い合わせください
重要
allow_client_id_assignment 設定は 2021 年 6 月に廃止され、 クライアントが client_id を指定する挙動のみとなります。
コネクション ID 導入の経緯¶
Sora 19.04 から接続ごとのユニークな ID として connection_id を払い出すようになりました。これは今までの client_id と同等のものです。
一方、 client_id はシグナリング開始時、または認証成功時の戻り値にて指定が可能になりました。また client_id は重複が可能になりました。この仕組を利用することで複数の接続を 1 つの client_id で管理することできるようになります。指定可能な client_id は 255 バイトまでの文字列です。
この仕組は 1 クライアントが複数の接続を保持したり、 1 クライアントが複数の端末から利用している場合に、 シグナリング経由でのプッシュ通知や、 API 経由での切断を一つの API で行うことを目的としています。
今までは 1 接続 1 クライアント ID という仕組みをとってきましたが、今回の変更で 1 接続 1 コネクション ID と定義し直しました。複数接続 1 クライアント ID が実現可能になりました。
変更要点¶
今までの
client_idのようにすべての接続でユニークな値であるconnection_idが払い出されるようになりますsora.confにてallow_client_id_assignmentをtrueにすることでシグナリング開始時と認証成功時の戻り値でclient_idの指定が可能になりますclient_idの重複が可能になります
変更点一覧¶
シグナリングの
type: offer時にconnection_idが払い出され、常にユニークになります認証とイベントウェブフック時に
connection_idが追加されますsora.confにallow_client_id_assignment設定が追加されます設定を有効にした場合、シグナリング開始時に
client_idの指定が可能になります設定を有効にした場合、認証ウェブフック成功時に
client_idの指定が可能になります設定を有効にした場合、シグナリング開始時に
client_idが指定されない場合、認証ウェブフック時に通知されるclient_idが含まれなくなります設定を有効にした場合、
client_idの重複が可能になります設定有効時には API で今まで
client_idを指定できたものはconnection_idでの指定が必要になります
client_idをクライアントからも認証サーバからも指定しない場合はclient_idは今までどおりユニークになります今まで
client_idが含まれていた API の戻り値やログにconnection_idの項目が追加されます
API の変更点¶
PushClient API¶
API の指定方法は後方互換性が維持されます。
ただし sora.conf にて allow_client_id_assignment を true にした場合は、
指定した client_id が割り当てられた全ての接続にプッシュ通知が送られます。
DisconnectClient API¶
API の指定方法は後方互換性が維持されます。
ただし sora.conf にて allow_client_id_assignment を true にした場合は、
指定した client_id が割り当てられた全ての接続が切断されます。
GetStats API¶
API の指定方法は後方互換性が維持されます。
ただし sora.conf にて allow_client_id_assignment を true にした場合は、 利用ができなくなります。
代わりに GetStatsClient API と GetStatsConnection API を利用してください。
StartForwardingRtp API¶
API の指定方法は後方互換性が維持されます。
ただし sora.conf にて allow_client_id_assignment を true にした場合は、 client_id が指定できなくなります。
代わりに connection_id を指定してください。
StopForwardingRtp API¶
API の指定方法は後方互換性が維持されます。
ただし sora.conf にて allow_client_id_assignment を true にした場合は、 client_id が指定できなくなります。
代わりに connection_id を指定してください。
Disconnect API¶
API の指定方法は後方互換性が維持されます。
ただし sora.conf にて allow_client_id_assignment を true にした場合は、 利用ができなくなります。
代わりに DisconnectClient API と DisconnectConnection API を利用してください。