connection.h
Este archivo incluye la definición del tipo de una estructura de conexión, que representa a un cliente conectado a una sesión de OpenTok, junto con varias declaraciones de funciones relacionadas con las conexiones de los clientes.
Incluye: config.h, base.h
typedef otc_connection
Definición de tipo para una estructura que representa a un cliente conectado a una sesión de OpenTok.
typedef struct otc_connection otc_connection;
Funciones
| Nombre | Descripción |
|---|---|
otc_connection_get_id(connection) → {const char *} |
Devuelve el identificador único de esta conexión. |
otc_connection_get_creation_time(connection) → {int64_t} |
Devuelve la marca de tiempo correspondiente al momento en que el cliente se conectó a la sesión de OpenTok. |
otc_connection_get_data(connection) → {const char *} |
Devuelve los datos asociados a la conexión. |
otc_connection_get_session_id(connection) → {const char *} |
Obtiene el identificador de sesión de la sesión a la que está conectada la conexión. |
otc_connection_copy(connection) → {otc_connection *} |
Crea una copia de esta conexión. |
otc_connection_delete(connection) → {otc_status} |
Libera los recursos asociados a la conexión. |
otc_connection_get_id(connection) → {const char *}
Devuelve el identificador único de esta conexión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
const otc_connection * | La conexión del cliente. |
Devoluciones:
El identificador único de esta conexión.
otc_connection_get_creation_time(conexión) → {int64_t}
Devuelve la marca de tiempo correspondiente al momento en que el cliente se conectó a la sesión de OpenTok.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
const otc_connection * | La conexión del cliente. |
Devoluciones:
La hora en la que el cliente se conectó a la sesión de OpenTok.
otc_connection_get_data(conexión) → {const char *}
Devuelve los datos asociados a la conexión. Estos datos se configuran al crear el token que utiliza el cliente para conectarse a la sesión de OpenTok. Consulte la Visión general de la creación de tokens guía del desarrollador.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
const otc_connection * | La conexión del cliente. |
Devoluciones:
Los datos de conexión.
otc_connection_get_session_id(conexión) → {const char *}
Obtiene el identificador de sesión de la sesión a la que está conectada la conexión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
const otc_connection * | La conexión del cliente. |
Devoluciones:
El identificador de sesión correspondiente a la sesión.
otc_connection_copy(conexión) → {otc_connection *}
Crea una copia de esta conexión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
const otc_connection * | La conexión del cliente que se va a copiar |
Devoluciones:
Una copia de la conexión. Se establece en «null» si se produce un error.
otc_connection_delete(conexión) → {otc_status}
Libera los recursos asociados a la conexión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
connection |
otc_connection * | La conexión del cliente para la versión. |
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.