CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
ネームスペース nn::pia::sync

PiaSync の名前空間です。 PiaSync は入力同期ゲーム通信を実現するためのモジュールです。 [詳細]

構成

class  SyncProtocol
 データ同期通信を行うためのプロトコルです。
サポート対象のネットワークトポロジーはフルメッシュ型のみです。スター型、リレーメッシュ型はサポート対象外ですので注意してください。 [詳細]
 

関数

初期化終了処理
Result Initialize ()
 PiaSync モジュールを初期化します。 事前に nn::pia::common::Initialize を実行する必要があります。
 
Result BeginSetup (void)
 セットアップの開始を宣言します。
 
Result EndSetup (void)
 セットアップの終了を宣言します。
 
bool IsInitialized (void)
 PiaSync モジュールが初期化された状態であるかどうかを返します。
 
void Finalize (void)
 PiaSync モジュールを終了します。 nn::pia::common::Finalize を実行する前に実行する必要があります。
 

説明

PiaSync の名前空間です。 PiaSync は入力同期ゲーム通信を実現するためのモジュールです。

関数

Result nn::pia::sync::BeginSetup ( void  )

セットアップの開始を宣言します。

sync モジュール以下の初期化処理を実行する前に呼び出す必要があります。

注意
別のモジュールのセットアップ処理とバッティングすると正しく動作しません。
sync::BeginSetup 呼び出し後、sync モジュール以下の初期化処理を行い、速やかに sync::EndSetup を呼び出してセットアップを完了する必要があります。
戻り値
この API を適切なタイミングで呼び出していれば、成功の Result が返されます。
返るエラーの一覧:

nn::pia::ResultNotInitialized sync::Initialize が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultInvalidState セットアップ期間中に再度呼び出しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

Result nn::pia::sync::EndSetup ( void  )

セットアップの終了を宣言します。

sync モジュール以下の初期化処理を実行する後に呼び出す必要があります。
この API 呼び出しにより、sync モジュールのシングルトンなどが消費するメモリを確定し、ライブラリ内部でのメモリ管理を最適化します。

注意
別のモジュールのセットアップ処理とバッティングすると正しく動作しません。
sync::BeginSetup 呼び出し後、sync モジュール以下の初期化処理を行い、速やかに sync::EndSetup を呼び出してセットアップを完了する必要があります。
戻り値
この API を適切なタイミングで呼び出していれば、成功の Result が返されます。
返るエラーの一覧:

nn::pia::ResultNotInitialized sync::Initialize が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

void nn::pia::sync::Finalize ( void  )

PiaSync モジュールを終了します。 nn::pia::common::Finalize を実行する前に実行する必要があります。

本関数を実行する前に PiaSync モジュールのすべての処理を終了しておく必要があります。 なお、sync::Initialize を実行していない状態では何もしません。

Result nn::pia::sync::Initialize ( )

PiaSync モジュールを初期化します。 事前に nn::pia::common::Initialize を実行する必要があります。

sync モジュールが動的に確保し使用するメモリは nn::pia::common::Initialize で渡したメモリから 確保されます。

戻り値
この API を適切なタイミングで呼び出していれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidState 既にこの関数を実行し、初期化が完了している状態です。
bool nn::pia::sync::IsInitialized ( void  )

PiaSync モジュールが初期化された状態であるかどうかを返します。

戻り値
初期化されていれば true、されていなければ false が返されます。