Connexion client. En savoir plus...
#include "config.h"
#include "base.h"
| Définitions de types | |
| typedef struct otc_connection | otc_connection |
| Fonctions | |
| const char * | otc_connection_get_id (const otc_connection *connexion) |
| int64_t | otc_connection_get_creation_time (const otc_connection *connexion) |
| const char * | otc_connection_get_data (const otc_connection *connexion) |
| const char * | otc_connection_get_session_id (const otc_connection *connexion) |
| otc_connection * | otc_connection_copy (const otc_connection *connexion) |
| otc_status | otc_connection_delete (otc_connection *connexion) |
Description détaillée
Connexion client.
Ce fichier contient la définition de type d'une structure de connexion, représentant un client connecté à une session OpenTok, ainsi que plusieurs déclarations de fonctions liées aux connexions des clients.
Documentation sur `typedef`
otc_connection
| typedef struct otc_connection otc_connection |
Définition de type pour une structure représentant un client connecté à une session OpenTok.
Documentation des fonctions
otc_connection_copy()
| otc_connection * otc_connection_copy | ( | const otc_connection * | connexion | ) |
Crée une copie de cette connexion.
Paramètres : | | | | --- | --- | | connexion | La connexion client à copier |
Retourne : Une copie de la connexion. Elle est définie sur null en cas d'erreur.
otc_connection_delete()
| otc_status otc_connection_delete | ( | otc_connection * | connexion | ) |
Libère les ressources associées à la connexion.
Paramètres : | | | | --- | --- | | connexion | Connexion client à fermer. |
Valeurs de retour : Valeur de retour indiquant soit une erreur, soit une réussite.
otc_connection_get_creation_time()
| int64_t otc_connection_get_creation_time | ( | const otc_connection * | connexion | ) |
Renvoie l'horodatage correspondant au moment où le client s'est connecté à la session OpenTok.
Paramètres : | | | | --- | --- | | connexion | La connexion du client. |
Retourne : L'heure à laquelle le client s'est connecté à la session OpenTok.
otc_connection_get_data()
| const char * otc_connection_get_data | ( | const otc_connection * | connexion | ) |
Renvoie les données associées à la connexion. Vous définissez ces données lors de la création du jeton utilisé par le client pour se connecter à la session OpenTok. Consultez la section Aperçu de la création de jetons guide du développeur.
Paramètres : | | | | --- | --- | | connexion | La connexion du client. |
Retourne : Les données de connexion.
otc_connection_get_id()
| const char * otc_connection_get_id | ( | const otc_connection * | connexion | ) |
Renvoie l'identifiant unique de cette connexion.
Paramètres : | | | | --- | --- | | connexion | La connexion du client. |
Résultats : L'identifiant unique de cette connexion.
otc_connection_get_session_id()
| const char * otc_connection_get_session_id | ( | const otc_connection * | connexion | ) |
Récupère l'identifiant de la session à laquelle la connexion est associée.
Paramètres : | | | | --- | --- | | connexion | La connexion du client. |
Retourne : L'identifiant de la session.