skyway::Context クラス

アプリケーションでSkyWay全体の設定、取得を行うStaticなコンテキスト [詳解]

#include <context.hpp>

skyway::Context の継承関係図

クラス
struct	SkyWayOptions
	SkyWayの利用に関する設定 [詳解]

静的公開メンバ関数
static bool	Setup (const std::string &token, core::Context::EventListener *listener, const SkyWayOptions &options)
	Contextを初期化します。
static bool	SetupForDev (const std::string &app_id, const std::string &secret_key, core::Context::EventListener *listener, const SkyWayOptions &options)
	Contextを初期化します。このメソッドは動作確認用です。
static void	Dispose ()
	SkyWayを終了し、Contextを破棄します。
static std::string	GetVersionString ()
	SkyWay Linux SDKのバージョンを取得します。
基底クラス skyway::core::Context に属する継承静的公開メンバ関数
static bool	Setup (const std::string &token, std::unique_ptr< HttpClientInterface > http, std::unique_ptr< WebSocketClientFactoryInterface > ws_factory, std::unique_ptr< PlatformInfoDelegatorInterface > platform_info, std::unique_ptr< LoggerInterface > logger, EventListener *listener, const ContextOptions &options)
	Contextを初期化します。
static bool	UpdateAuthToken (const std::string &token)
	JWTを更新します。
static void	RegisterPlugin (std::unique_ptr< RemoteMemberPluginInterface > plugin)
	RemoteMemberPluginを登録します。
static void	Dispose ()
	コンテキストを破棄し、全ての接続を切断します。

静的公開変数類
static const unsigned int	kVersionMajor = 3
static const unsigned int	kVersionMinor = 0
static const unsigned int	kVersionPatch = 0

詳解

アプリケーションでSkyWay全体の設定、取得を行うStaticなコンテキスト

特別な理由がない場合はcore::Contextでなく、こちらを利用してください。

関数詳解

Dispose()

static void skyway::Context::Dispose ( )

static

SkyWayを終了し、Contextを破棄します。

コンテキストを破棄し、全ての接続を切断します。 SkyWayの利用が不要になった時にコールしてください。 Dispose完了後にSDKで生成されたリソースにアクセスしないでください。 skyway::Context::Setup()を再度コールすることで利用可能になります。

Setup()

static bool skyway::Context::Setup ( const std::string &  token, core::Context::EventListener *  listener, const SkyWayOptions &  options  )

static

Contextを初期化します。

SkyWayを利用するためには必ずこのメソッドを最初にコールする必要があります。

引数

token	JWT形式のAuthトークン
listener	イベントリスナ
options	オプション

SetupForDev()

static bool skyway::Context::SetupForDev ( const std::string &  app_id, const std::string &  secret_key, core::Context::EventListener *  listener, const SkyWayOptions &  options  )

static

Contextを初期化します。このメソッドは動作確認用です。

認証情報の漏洩を防ぐため、このメソッドをリリース版で利用することは控えてください。

引数

app_id	アプリケーションID
secret_key	アプリケーションのシークレットキー
listener	イベントリスナ
options	オプション

---

このクラス詳解は次のファイルから抽出されました:

• include/skyway/context.hpp