シグナリング — Linux

OpenTokシグナリングAPIを使用して、OpenTokセッションに接続されているクライアント間でテキストやデータを送信します。

OpenTokシグナリングAPIに関する概念的な情報については、 シグナリングの概要 開発者ガイド

このトピックには以下のセクションが含まれます：

セッション内の特定のクライアントにシグナルを送信する

セッション内の特定のクライアントにシグナルを送信するには、 otc_session_send_signal_to_connection() 関数である：

otc_session_send_signal_to_connection(session, "chat", "Hello", connection1);

について type パラメータとは、クライアントがフィルタリングを行う際に使用できる文字列値のことです。 信号を待ち受ける. 型を設定する必要がない場合は、これを空の文字列に設定してください。

について signal このパラメータは、メッセージとともに送信するデータペイロード（文字列）を指定します。データのサイズ上限は8KBです。

について connection パラメータは otc_connection シグナルを送信したいセッションに接続されているクライアントに対応する構造体。以下の参照を取得します。 otc_connection の構造体 connection パラメーターの on_connection_created のコールバック関数である。 otc_session_callbacks インスタンス。

セッション内のすべてのクライアントに信号を送信する

セッション内のすべてのクライアントに信号を送信するには、 otc_session_send_signal() 関数である：

otc_session_send_signal(session, "chat", "Hello");

について type パラメータとは、クライアントがフィルタリングを行う際に使用できる文字列値のことです。 信号を待ち受ける. 型を設定する必要がない場合は、これを空の文字列に設定してください。

について signal このパラメータは、メッセージとともに送信するデータペイロード（文字列）を指定します。データのサイズ上限は8KBです。

セッションでの信号の受信

について on_signal_received() のコールバック関数である。 otc_session_callbacks struct は、セッションでシグナルを受信した際に呼び出されます。これには以下のパラメータが含まれます：

  • session — へのポインタ otc_session インスタンスだ。
  • user_data — ユーザーデータへのポインタ。
  • type — シグナルの型「string」へのポインタ。
  • signal — シグナルのデータ文字列へのポインタ。
  • connection — へのポインタ otc_connection シグナルを送信したクライアントを特定するインスタンス。

なお、 REST APIコール セッションに接続しているクライアントではなく、サーバー側からシグナルを送信する場合。この場合、 connection パラメーターの on_signal_received() に設定されている。 null.

自動再接続中に信号が送信されないようにする

クライアントは、予期せず（たとえば、ネットワーク接続が切断された場合など）セッションから切断された際、自動的に再接続を試みます。デフォルトでは、クライアントがセッションから一時的に切断されている間に送信されたシグナルはすべてキューに入れられ、再接続に成功した時点で（成功した場合に限り）送信されます。この設定は、 retryAfterReconnect) のメンバーである。 otc_signal_options に渡しする構造体 otc_session_send_signal_with_options() 関数または otc_session_send_signal_to_connection_with_options() 関数を false クライアントが切断されている間、信号がキューに蓄積されるのを防ぐためです。詳細については、以下を参照してください。 自動再接続.