connection.h

クライアント接続。続きを読む...

#include "config.h" #include "base.h"


型定義
typedef struct otc_connection	otc_connection


機能
const char *	otc_connection_get_id (const otc_connection *接続)
int64_t	otc_connection_get_creation_time (const otc_connection *接続)
const char *	otc_connection_get_data (const otc_connection *接続)
const char *	otc_connection_get_session_id (const otc_connection *接続)
otc_connection *	otc_connection_copy (const otc_connection *接続)
otc_status	otc_connection_delete (otc_connection *接続)

詳細な説明

クライアント接続。

このファイルには、OpenTok セッションに接続されたクライアントを表す接続構造体の型定義と、クライアントの接続に関連するいくつかの関数の宣言が含まれています。


typedef struct otc_connection otc_connection

OpenTok セッションに接続されたクライアントを表す構造体の型定義。


otc_connection * otc_connection_copy	(	const otc_connection *	接続	)

この接続のコピーを作成します。

パラメータ : | | | | --- | --- | | connection | コピーするクライアント接続 |

戻り値 : 接続のコピー。エラーが発生した場合は null に設定されます。


otc_status otc_connection_delete	(	otc_connection *	接続	)

その接続に関連付けられたリソースを解放します。

パラメータ : | | | | --- | --- | | connection | 解放するクライアント接続。 |

戻り値 : エラーか成功かを示す戻り値。


int64_t otc_connection_get_creation_time	(	const otc_connection *	接続	)

クライアントが OpenTok セッションに接続した時点のタイムスタンプを返します。

パラメータ : | | | | --- | --- | | connection | クライアント接続。 |

戻り値 : クライアントが OpenTok セッションに接続した時刻。


const char * otc_connection_get_data	(	const otc_connection *	接続	)

接続に関連付けられたデータを返します。このデータは、クライアントが OpenTok セッションに接続するために使用するトークンを作成する際に設定します。詳しくは、トークン作成の概要開発者ガイド

パラメータ : | | | | --- | --- | | connection | クライアント接続。 |

戻り値 : 接続データ。


const char * otc_connection_get_id	(	const otc_connection *	接続	)

この接続の一意の識別子を返します。

パラメータ : | | | | --- | --- | | connection | クライアント接続。 |

戻り値 : この接続の一意の識別子。


const char * otc_connection_get_session_id	(	const otc_connection *	接続	)

接続されているセッションのセッションIDを取得します。

パラメータ : | | | | --- | --- | | connection | クライアント接続。 |

戻り値 : セッションのセッションID。