Client SDK for Cocos2d-x Reference

1 はじめに

Client SDK for Cocos2d-x が提供する機能(API)とその利用方法について解説します。

tips用アイコン

  • 開発環境にXcodeを使用した前提で解説します。
  • Cocos2d-x および C++ での開発基礎知識をお持ちの開発者を前提に記載しています。そのため、Cocos2d-x と C++ の説明については割愛します。

2 MAGELLAN を利用するために

MAGELLAN を利用するには、実装されるソースファイル上で下記を実施してください。

2.1 ヘッダファイルの読み込み

以下のようにソースファイル上で定義して Magellan.h を読み込んでください。

#include "Magellan/Magellan.h"

2.2 MAGELLAN 名前空間指定

MAGELLAN を構成する各種クラスは Magellan 名前空間に定義されています。

また、それに付随して一部 Network 名前空間に定義されています。

必要に応じて以下のように using 宣言を行うことで名前空間の指定を省略できます。

using namespase Network;
using namespase Magellan;

2.3 接続先設定

MAGELLAN にアクセスするときのサーバ情報(ホストポート)については サーバ情報 を参照して設定してください。
また、Consumer keyConsumer Secretについてmagellan-cliproject list で確認して設定してください。

3 ファイル構成

Client SDK for Cocos2d-x のファイル構成について解説します。

Clienet SDK for Cocos2d-x ファイル構成図

ファイル名 内容
Magellan.h MAGELLAN ライブラリヘッダ include 定義ファイルです。
本ヘッダファイルをインクルードすることで、MAGELLAN 利用に必要なすべてのヘッダファイルを一括で読み込みできます。
MagellanManager.h MAGELLAN ライブラリ管理クラスです。
MAGELLAN が提供する各機能は本クラスを通じて呼び出されます。
WorkerRequest.h Worker API のリクエストクラスです。
BaseRequest.h Worker API リクエストクラスの基底クラスです。
MagellanClient.h MAGELLAN 機能(Worker HTTP 型通信、Publish/Subscribe 型通信)のハンドラクラスです。
PubSub_Subscriber.h Worker(Publish/Subscribe 型通信)のサブスクライバークラスです。
PubSub_PublishRequest.h Worker(Publish/Subscribe 型通信)のパブリッシュリクエストクラスです。
Network フォルダ MAGELLAN ライブラリを構成する各クラスヘッダファイルが格納されています。