4 MAGELLAN 利用方法

Client SDK for Unity の基本的な利用方法について解説します。

MAGELLANでは以下2つの機能を提供しています。

  • Worker(HTTP型通信)
  • Worker(Publish/Subscribe型通信)

tips用アイコン

4.1 Worker(HTTP 型通信)

HTTP 型通信を利用する場合、基本的に以下の流れで実装します。

4.1.1 MAGELLAN Manager インスタンス取得

MAGELLANの各機能はManagerクラスを通じて呼び出されます。
そのため、MAGELLANを利用するにはManagerクラスのプロパティにアクセスしてインスタンス取得してください。

4.1.2 クライアントハンドル作成

MAGELLANを利用するにはクライアントハンドル生成が必要となります。
クライアントハンドル生成には割り当てられたホストポートConsumerKeyConsumerSecret の指定が必要です。

4.1.3 初期化処理

クライアントハンドル生成後は必ず1度初期化を行ってください。
初期化にはクライアントハンドルクライアントバージョンの指定が必要です。

4.1.4 Worker リクエスト用インスタンス作成

Workerリクエストに必要なインスタンスを生成します。
インスタンス生成にはリクエスト実行するAPI のURL のディレクトリ部リクエストメソッドプロトコルスキーム指定が必要です。

4.1.5 Worker リクエストコールバック設定

Workerリクエスト実行後、レスポンス受信・リクエストエラー発生時に呼び出されるコールバックを設定します。

4.1.6 Worker リクエスト実行

Workerリクエストを実行します。

4.1.7 Worker リクエスト結果受信(コールバック受信)

Workerリクエスト実行後レスポンスを受信すると、4.1.5 Workerリクエストコールバック設定 で設定したコールバックが呼び出され、レスポンス内容を確認することができます。
リクエストでエラーが発生した場合はエラーコールバックが呼び出されます。 リクエスト結果に応じた処理はコールバックで実装してください。

4.2 Worker(Publish/Subscribe 型通信)

Publish/Subscribe 型通信を利用する場合、基本的に以下の流れで実装します。

4.2.1 MAGELLAN Manager インスタンス取得

MAGELLANの各機能はManagerクラスを通じて呼び出されます。
そのため、MAGELLANを利用するにはManagerクラスのプロパティにアクセスしてインスタンス取得してください。

4.2.2 クライアントハンドル作成

MAGELLANを利用するにはクライアントハンドル生成が必要となります。
クライアントハンドル生成には割り当てられたホストポートConsumerKeyConsumerSecretの指定が必要です。

4.2.3 初期化処理

クライアントハンドル生成後は必ず1度初期化を行ってください。
初期化にはクライアントハンドルクライアントバージョンの指定が必要です。

4.2.4 Publish/Subscribe(MQTT)接続・切断コールバック設定

Publish/Subscribe(MQTT)接続・切断完了時に呼び出されるコールバックを設定します。

4.2.5 Publish/Subscribe(MQTT)接続要求

Publish/Subscribeリクエスト実行する前にPublish/Subscribe(MQTT)接続を行います。
接続状態に応じて 4.2.4. Publish/Subscribe接続・切断(MQTT)コールバック設定 で設定したコールバックが呼び出されます。

4.2.6 Worker(Publish/Subscribe)リクエスト用インスタンス作成

Publish/Subscribeリクエストに必要なインスタンスを作成します。
インスタンス生成にはTopicQoS指定が必要です。

4.2.7 Worker(Publish/Subscribe)リクエストコールバック設定

Publishを行う場合

Publish実行完了時に実行されるコールバックを設定します。

Subscribeを行う場合

Subscribe登録・解除、Subscribe受信時に実行されるコールバックを設定します。

4.2.8 Worker(Publish/Subscribe)リクエスト実行

Publish/Subscribeリクエストを実行します。

4.2.9 Worker(Publish/Subscribe)リクエスト結果受信(コールバック受信)

Publish/Subscribeリクエスト実行後はリクエスト内容に応じて、4.2.7.Worker(Publish/Subscribe)リクエストコールバック設定 で設定したコールバックが呼び出されます。 リクエスト結果に応じた処理はコールバックで実装してください。