Signalisation — Linux

Utilisez l'API de signalisation OpenTok pour échanger du texte et des données entre les clients connectés à une session OpenTok.

Pour obtenir des informations conceptuelles sur l'API de signalisation OpenTok, consultez le Aperçu de la signalisation guide du développeur.

Cette rubrique comprend les sections suivantes :

Envoi d'un signal à un client spécifique au cours d'une session

Pour envoyer un signal à un client spécifique au cours d'une session, appelez la fonction otc_session_send_signal_to_connection() fonction :

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

Les type Le paramètre est une chaîne de caractères que les clients peuvent utiliser comme critère de filtrage lorsque être à l'écoute des signaux. Définissez cette valeur sur une chaîne vide si vous n'avez pas besoin de spécifier un type.

Les signal Ce paramètre spécifie la charge utile (une chaîne de caractères) que vous envoyez avec le message. La taille maximale des données est de 8 Ko.

Les connection est un pointeur sur un otc_connection structure correspondant à un client connecté à la session à laquelle vous souhaitez envoyer un signal. Vous obtenez des références vers otc_connection structures dans le connection du paramètre on_connection_created de la fonction de rappel du otc_session_callbacks par exemple .

Envoi d'un signal à tous les clients d'une session

Pour envoyer un signal à tous les clients d'une session, appelez la fonction otc_session_send_signal() fonction :

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

Les type Le paramètre est une chaîne de caractères que les clients peuvent utiliser comme critère de filtrage lorsque être à l'écoute des signaux. Définissez cette valeur sur une chaîne vide si vous n'avez pas besoin de spécifier un type.

Les signal Ce paramètre spécifie la charge utile (une chaîne de caractères) que vous envoyez avec le message. La taille maximale des données est de 8 Ko.

Réception de signaux au cours d'une session

Les on_signal_received() de la fonction de rappel du otc_session_callbacks La fonction `struct` est appelée lorsqu'un signal est reçu dans une session. Elle comprend les paramètres suivants :

  • session — Un pointeur vers le otc_session instance.
  • user_data — Un pointeur vers les données utilisateur.
  • type — Un pointeur vers la chaîne de caractères correspondant au type du signal.
  • signal — Un pointeur vers la chaîne de données correspondant au signal.
  • connection — Un pointeur vers le otc_connection instance permettant d'identifier le client qui a envoyé le signal.

Notez que vous pouvez utiliser un Appel à l'API REST pour envoyer un signal depuis votre serveur, plutôt que depuis un client connecté à la session. Dans ce cas, le connection du paramètre on_signal_received() est fixé à null.

Empêcher l'envoi de signaux lors d'une reconnexion automatique

Les clients tenteront de se reconnecter automatiquement à une session dont ils se sont déconnectés de manière inattendue (par exemple, en raison d'une interruption de la connexion réseau). Par défaut, tous les signaux que vous envoyez pendant que le client est temporairement déconnecté d'une session sont mis en file d'attente et envoyés lorsque (et si) la reconnexion aboutit. Vous pouvez configurer le retryAfterReconnect) membre de la otc_signal_options struct que vous transmettez à la otc_session_send_signal_with_options() ou la fonction otc_session_send_signal_to_connection_with_options() à la fonction false afin d'éviter que les signaux ne s'accumulent dans la file d'attente lorsque le client est déconnecté. Pour plus d'informations, consultez Reconnexion automatique.