CTR-Pia
5.4.3
Game Communication Engine
|
ローカルネットワークを扱うためのクラスです。 [詳細]
Public メソッド | |
uint32_t | CreateLocalCommunicationId (uint32_t uniqueId, bool isTrial=false) const |
ユニーク ID からローカル通信 ID を作成します。 | |
void | Finalize () |
終了処理です。 | |
Result | GetApplicationDataFromBeacon (void *pBuffer, uint32_t *pDataSize, uint32_t bufferSize) const |
ビーコンに設定されているデータを取得します。 | |
Result | GetApplicationDataSizeFromBeacon (uint32_t *pDataSize) const |
ビーコンに設定されているデータのサイズを取得します。 | |
DisconnectReason | GetDisconnectReason () |
ネットワークから切断された理由を取得します。 | |
uint8_t | GetLinkLevel () const |
リンクレベルを取得します。 | |
uint8_t | GetNetworkChannel () const |
使用中の IEEE 802.11b/g 無線チャンネルを取得します。 | |
Result | GetStationInfo (LocalStationInfo *pLocalStationInfo, const common::StationAddress &address) const |
指定したステーションの情報を取得します。 | |
Result | Initialize (const LocalNetworkSetting &setting) |
インスタンスを初期化します。 BeginSetup() ~ EndSetup() 間で呼び出す必要があります。 | |
bool | IsDuringHostMigration () const |
ローカルホストマイグレーション処理中であるかを取得します。 | |
virtual void | Trace (uint64_t flag) const |
デバッグに有用な情報をプリントします。 | |
Static Public メソッド | |
static Result | CreateInstance () |
LocalFacade クラスのインスタンスを作成します(シングルトンパターン)。 | |
static void | DestroyInstance () |
LocalFacade クラスのインスタンスを破棄します(シングルトンパターン)。 | |
static LocalFacade * | GetInstance () |
LocalFacade クラスのインスタンスを得ます(シングルトンパターン)。 事前に Initialize による初期化を済ませていない場合は、 NULLポインタが返されます。 | |
ローカルネットワークを扱うためのクラスです。
|
static |
LocalFacade クラスのインスタンスを作成します(シングルトンパターン)。
ResultNotInitialized local モジュールが未初期化です。
ResultInvalidState インスタンスを作成するタイミングが誤っています。
ResultAlreadyExists 既にインスタンスは作成されています。
uint32_t nn::pia::local::LocalFacade::CreateLocalCommunicationId | ( | uint32_t | uniqueId, |
bool | isTrial = false |
||
) | const |
ユニーク ID からローカル通信 ID を作成します。
業務部から割り当てられた 20bit のユニーク ID (タイトル固有の ID)から ローカル通信で使用する 32bit 値 (ローカル通信 ID) を生成します。
業務部からユニーク ID が割り当てられていない場合は、ゲームソフト試作用のユニーク ID ( 0xFF000 ~ 0xFF3FF ) を使用する必要があります。 transport::Transport::Initialize() を呼び出してから transport::Transport::Finalize() を呼び出すまでの間、有効な値が返ります。
[in] | uniqueId | ユニーク IDです。複数タイトル間で通信したい場合はどちらか片方のユニーク ID を指定する必要があります。 |
[in] | isTrial | ユニーク ID が製品版と体験版で共通だった場合の対処用フラグです。製品版-体験版間での通信を行いたくない場合、 体験版側で true を指定する必要があります。製品版は常に false が指定されるよう注意してください。 |
void nn::pia::local::LocalFacade::Finalize | ( | ) |
終了処理です。
Result nn::pia::local::LocalFacade::GetApplicationDataFromBeacon | ( | void * | pBuffer, |
uint32_t * | pDataSize, | ||
uint32_t | bufferSize | ||
) | const |
ビーコンに設定されているデータを取得します。
[out] | pBuffer | データを書き込むためのバッファ。 |
[out] | pDataSize | 取得したデータの長さ。 |
[in] | bufferSize | データを書き込むためのバッファのサイズ。 |
ResultNotInitialized 初期化されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState transport::Transport::Initialize() の呼び出しから transport::Transport::Finalize() の呼び出しまでの間に呼び出す必要があります。または、接続していないか、ホストマイグレーション処理中ですプログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidConnection 無線オフモードに遷移しました。クリーンアップ処理を実行してください。
ResultNotInCommunication 通信できない状態です。その内、切断検知されるか、またはホストマイグレーションが開始されます。ホストマイグレーション完了後に呼び出すことで成功する可能性があります。
Result nn::pia::local::LocalFacade::GetApplicationDataSizeFromBeacon | ( | uint32_t * | pDataSize | ) | const |
ビーコンに設定されているデータのサイズを取得します。
[out] | pDataSize | ビーコンに設定されているデータのサイズ。 |
ResultNotInitialized 初期化されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidState transport::Transport::Initialize() の呼び出しから transport::Transport::Finalize() の呼び出しまでの間に呼び出す必要があります。または、接続していないか、ホストマイグレーション処理中ですプログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidConnection 無線オフモードに遷移しました。クリーンアップ処理を実行してください。
ResultNotInCommunication 通信できない状態です。その内、切断検知されるか、またはホストマイグレーションが開始されます。ホストマイグレーション完了後に呼び出すことで成功する可能性があります。
DisconnectReason nn::pia::local::LocalFacade::GetDisconnectReason | ( | ) |
ネットワークから切断された理由を取得します。
Startup 時、Cleanup 時に DisconnectReason_None にリセットされます。
通信エラーの検知には、本関数ではなく session::Session::CheckConnectionError() を使用する必要があります。
|
inlinestatic |
LocalFacade クラスのインスタンスを得ます(シングルトンパターン)。 事前に Initialize による初期化を済ませていない場合は、 NULLポインタが返されます。
uint8_t nn::pia::local::LocalFacade::GetLinkLevel | ( | ) | const |
リンクレベルを取得します。
リンクレベルは、0~3 の 4 段階あり、0:非常に通信品質が悪い、もしくは通信が成立していない、 1:通信品質が悪い、2:通信品質があまり良くない、3:通信品質がよい という状態を表します。
uint8_t nn::pia::local::LocalFacade::GetNetworkChannel | ( | ) | const |
使用中の IEEE 802.11b/g 無線チャンネルを取得します。
Result nn::pia::local::LocalFacade::GetStationInfo | ( | LocalStationInfo * | pLocalStationInfo, |
const common::StationAddress & | address | ||
) | const |
指定したステーションの情報を取得します。
[out] | pLocalStationInfo | 取得したステーション情報を格納するバッファです。 |
[in] | address | 情報を取得したいステーションのアドレスです。 |
ResultNotInitialized LocalFacade がスタートアップされていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultNotFound 対象のステーションが見つかりませんでした。すでに切断されている可能性があります。
ResultInvalidConnection 無線オフモードに遷移しました。クリーンアップ処理を実行してください。
Result nn::pia::local::LocalFacade::Initialize | ( | const LocalNetworkSetting & | setting | ) |
インスタンスを初期化します。 BeginSetup() ~ EndSetup() 間で呼び出す必要があります。
[in] | setting | 各種設定情報です。 |
ResultAlreadyInitialized 既に初期化されています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
bool nn::pia::local::LocalFacade::IsDuringHostMigration | ( | ) | const |
ローカルホストマイグレーション処理中であるかを取得します。
|
virtual |
デバッグに有用な情報をプリントします。
[in] | flag | トレースフラグの論理和。詳細は TraceFlag 型を参照してください。 |