SkyWay Embedded SDK 0.1.0
読み取り中…
検索中…
一致する文字列を見つけられません
context.h
[詳解]
1//
2// © NTT DOCOMO BUSINESS, Inc. All Rights Reserved.
3//
4
5#pragma once
6
7#ifdef __cplusplus
8extern "C"
9{
10#endif
11
12#include <stdbool.h>
13#include <stdint.h>
14
15#include "auth_token.h"
16
18#define SKW_CONTEXT_SUPPRESS_LOG_TAGS {"AGENT", "BUF_MNGR", "PEER_DEF", "DTLS"}
19
59
61typedef struct {
63
65 struct {
67 } experimental;
69
73
80
84
89
90#ifdef __cplusplus
91}
92#endif
開発用AuthTokenの生成。
skw_context_err_t skw_context_init(void)
Contextを初期化します。他のAPIを利用する前に最初に一度呼び出す必要があります。
skw_context_err_t
Context APIのエラーコード。
Definition context.h:21
@ SKW_CONTEXT_ERR_CONNECTION_CLOSED
応答待ちの間に接続が切断された
Definition context.h:37
@ SKW_CONTEXT_FATAL_INIT_FAILED
致命的エラー: 初期化に失敗
Definition context.h:57
@ SKW_CONTEXT_ERR_DISCONNECT_FAILED
サーバーからの切断に失敗
Definition context.h:26
@ SKW_CONTEXT_ERR_TIMEOUT
応答の受信がタイムアウトした
Definition context.h:36
@ SKW_CONTEXT_ERR_UNKNOWN
不明なエラー
Definition context.h:43
@ SKW_CONTEXT_ERR_ALREADY_INITED
Contextがすでに初期化済み
Definition context.h:25
@ SKW_CONTEXT_ERR_SERVER_INTERNAL
サーバー内部エラー
Definition context.h:51
@ SKW_CONTEXT_FATAL_ALLOCATE_FAILED
致命的エラー: メモリ確保に失敗
Definition context.h:53
@ SKW_CONTEXT_ERR_BAD_REQUEST
不正なリクエスト
Definition context.h:44
@ SKW_CONTEXT_ERR_APP_ID_MISMATCH
AuthToken内のappIdが現在のappIdと一致しない
Definition context.h:34
@ SKW_CONTEXT_ERR_NOT_INITED
Contextが初期化されていない
Definition context.h:24
@ SKW_CONTEXT_ERR_SERVER_BUSY
サーバーが過負荷で一時的に利用できない
Definition context.h:52
@ SKW_CONTEXT_OK
正常終了
Definition context.h:22
@ SKW_CONTEXT_ERR_ALREADY_EXIST
すでに存在するリソースを作成しようとした
Definition context.h:48
@ SKW_CONTEXT_ERR_UNAUTHORIZED
AuthTokenが不正、もしくは有効期限切れ
Definition context.h:45
@ SKW_CONTEXT_ERR_MUTEX_UNLOCK_FAILED
Context APIのアンロックに失敗
Definition context.h:30
@ SKW_CONTEXT_ERR_SIGNALING_DISCONNECTED
シグナリングが切断された(復帰はdispose後のsetup/join)
Definition context.h:41
@ SKW_CONTEXT_ERR_SEND_FAILED
リクエストの送信に失敗
Definition context.h:35
@ SKW_CONTEXT_ERR_INVALID_TOKEN
AuthTokenが不正
Definition context.h:32
@ SKW_CONTEXT_ERR_NOT_FOUND
リソースが見つからない
Definition context.h:47
@ SKW_CONTEXT_ERR_NULL_ARGS
引数がNULL
Definition context.h:23
@ SKW_CONTEXT_ERR_FORBIDDEN
必要な権限が無い
Definition context.h:46
@ SKW_CONTEXT_ERR_TOO_LARGE
リクエストが大きすぎる
Definition context.h:49
@ SKW_CONTEXT_FATAL_CONNECT_FAILED
致命的エラー: サーバーへの接続に失敗
Definition context.h:56
@ SKW_CONTEXT_ERR_TOO_MANY_REQUESTS
レートリミット超過
Definition context.h:50
@ SKW_CONTEXT_ERR_API_TIMEOUT
Context APIがタイムアウトした
Definition context.h:29
@ SKW_CONTEXT_ERR_SIGNALING_FAILED
シグナリングの操作に失敗
Definition context.h:42
@ SKW_CONTEXT_ERR_APP_ID_TOO_LONG
AppIDが長すぎる
Definition context.h:31
@ SKW_CONTEXT_FATAL_SETUP_FAILED
致命的エラー: セットアップに失敗
Definition context.h:55
@ SKW_CONTEXT_FATAL_CLEANUP_FAILED
致命的エラー: クリーンアップに失敗
Definition context.h:54
@ SKW_CONTEXT_ERR_RESPONSE_PARSE_FAILED
応答の解析に失敗した
Definition context.h:39
@ SKW_CONTEXT_ERR_ALREADY_SETUP
Contextがすでにセットアップ済み
Definition context.h:28
@ SKW_CONTEXT_ERR_CALLED_IN_HANDLER
イベントハンドラ内から呼ばれた
Definition context.h:33
@ SKW_CONTEXT_ERR_NOT_SETUP
Contextがセットアップされていない
Definition context.h:27
@ SKW_CONTEXT_ERR_SIGNALING_NOT_ACTIVE
シグナリングのセッションが確立していない
Definition context.h:40
@ SKW_CONTEXT_ERR_RESPONSE_TOO_LARGE
応答が受信バッファのサイズを超過した
Definition context.h:38
skw_context_err_t skw_context_setup(skw_auth_token_t *auth_token, skw_context_setup_options_t *options)
Contextを初期化し、SkyWayサーバーへの接続を確立します。 disable_log_suppressionを指定しない場合、SKW_CONTEXT_SUPPRESS_LOG_TAGSのタグの出...
skw_context_err_t skw_context_update_auth_token(skw_auth_token_t *auth_token)
認証に使用するAuthTokenを新しいAuthTokenへ更新します。
skw_context_err_t skw_context_dispose(void)
SkyWayサーバーとの通信を切断、確保したリソースを解放します。
生成したAuthTokenを保持する構造体。
Definition auth_token.h:28
Contextの初期化時に使用するオプション。
Definition context.h:61
bool disable_log_suppression
SKW_CONTEXT_SUPPRESS_LOG_TAGSのタグの出力を抑制しません。
Definition context.h:62
bool enable_video_subscribe
VideoのSubscribeを許可します。Videoの受信は通信処理の負荷が高く注意が必要です。
Definition context.h:66