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

(デバッグ用)デバッグ用ダミーセッションを扱うクラスです。(製品版には含まれません) [詳細]

+ nn::pia::inet::NexDebugSessionに対する継承グラフ

Public メソッド

void Cleanup ()
 NexDebugSession 機能をクリーンアップします。
 
Result CreateDummySessionAsync (const NexCreateSessionSetting &createSessionSetting)
 ダミーセッションの構築を行います。
 
Result DestroyDummySessionAsync (uint32_t sessionId)
 ダミーセッションの削除を行います。
 
uint32_t GetCreatedDummySessionId () const
 構築したダミーセッションのセッション ID を取得します。
 
Result GetCreateDummySessionResult () const
 CreateDummySessionAsync の非同期処理の結果を取得します。
 
Result GetDestroyDummySessionResult () const
 DestroyDummySessionAsync の非同期処理の結果を取得します。
 
Result GetUpdateDummySessionResult () const
 UpdateDummySessionAsync の非同期処理の結果を取得します。
 
bool IsCreateDummySessionCompleted ()
 CreateDummySessionAsync の非同期処理の完了をチェックします。
 
bool IsDestroyDummySessionCompleted ()
 DestroyDummySessionAsync の非同期処理の完了をチェックします。
 
bool IsUpdateDummySessionCompleted ()
 UpdateDummySessionAsync の非同期処理の完了をチェックします。
 
Result Startup ()
 NexDebugSession 機能をスタートアップします。
 
Result UpdateDummySessionAsync (uint32_t sessionId, const NexUpdateSessionSetting &updateSessionSetting)
 ダミーセッションの設定更新を行います。
 

Static Public メソッド

static Result CreateInstance ()
 インスタンスを作成します(シングルトンパターン)。
 
static void DestroyInstance ()
 インスタンスを破棄します(シングルトンパターン)。
 
static NexDebugSessionGetInstance ()
 NexDebugSession インスタンスへのポインタを取得します(シングルトンパターン)。
 

説明

(デバッグ用)デバッグ用ダミーセッションを扱うクラスです。(製品版には含まれません)

関数

void nn::pia::inet::NexDebugSession::Cleanup ( )

NexDebugSession 機能をクリーンアップします。

NexFacade::Unbind より前に呼び出す必要があります。

Result nn::pia::inet::NexDebugSession::CreateDummySessionAsync ( const NexCreateSessionSetting createSessionSetting)

ダミーセッションの構築を行います。

ダミーセッションの構築を行う非同期処理を開始します。 構築したダミーセッションのホストになります。クライアントはダミーセッションに参加できません。 開始した処理は nn::pia::common::Scheduler::Dispatch を定期的に呼び出すことで進行します。 処理の完了は IsCreateDummySessionCompleted でチェックし、結果は GetCreateDummySessionResult で確認できます。 構築されたダミーセッションのセッション ID は GetCreatedDummySessionId で取得できます。

引数
[in]createSessionSettingセッションを作成する際の条件
戻り値
非同期処理の開始に成功すれば、成功の Result が返されます。失敗した場合、以下の Result を返します。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 非同期処理開始時に渡した引数の設定内容が想定外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultInvalidState 呼び出し時に適切な状態ではありませんでした。他の非同期処理が行われていないこと、Startup が呼び出されていること、Session::Startup を呼び出していないか確認してください。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

参照
IsCreateDummySessionCompleted, GetCreateDummySessionResult, GetCreatedDummySessionId
static Result nn::pia::inet::NexDebugSession::CreateInstance ( )
static

インスタンスを作成します(シングルトンパターン)。

戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

nn::pia::ResultNotInitialized inet モジュールが未初期化です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

nn::pia::ResultAlreadyExists 既にインスタンスは作成されています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

Result nn::pia::inet::NexDebugSession::DestroyDummySessionAsync ( uint32_t  sessionId)

ダミーセッションの削除を行います。

ダミーセッションの削除を行う非同期処理を開始します。 開始した処理は nn::pia::common::Scheduler::Dispatch を定期的に呼び出すことで進行します。 処理の完了は IsDestroyDummySessionCompleted でチェックし、結果は GetDestroyDummySessionResult で確認できます。

引数
[in]sessionId削除するダミーセッションのセッション ID
戻り値
非同期処理の開始に成功すれば、成功の Result が返されます。失敗した場合、以下の Result を返します。
返るエラーの一覧:
nn::pia::ResultInvalidState 呼び出し時に適切な状態ではありませんでした。他の非同期処理が行われていないこと、Startup が呼び出されていること、Session::Startup を呼び出していないか確認してください。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
参照
IsDestroyDummySessionCompleted, GetDestroyDummySessionResult
static void nn::pia::inet::NexDebugSession::DestroyInstance ( )
static

インスタンスを破棄します(シングルトンパターン)。

インスタンスが作成されていないときにこの関数が呼び出された場合は、何も実行せずに関数から返ります。

uint32_t nn::pia::inet::NexDebugSession::GetCreatedDummySessionId ( ) const

構築したダミーセッションのセッション ID を取得します。

戻り値
構築したダミーセッションのセッション ID を返します。
Result nn::pia::inet::NexDebugSession::GetCreateDummySessionResult ( ) const

CreateDummySessionAsync の非同期処理の結果を取得します。

CreateDummySessionAsync で開始された非同期処理が完了した後、本関数で結果を取得できます。

戻り値
IsSuccess() が真となる Result を返します。失敗した場合、以下の Result を返します。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 非同期処理開始時に渡した引数の設定内容が想定外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultInvalidState 21個以上のダミーセッションを構築しようとしました。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultGameServerMaintenance ゲームサーバーのメンテナンスが行われています。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。セッション離脱処理、クリーンアップ処理、NEX サーバーからのログアウト処理を順に実行してください。

nn::pia::ResultNexInternalError NEX の内部エラーです。nn::pia::Result::GetErrorCode() で取得できるエラーコードは NEX のものになります。エラーコードリストの NEX の項目をご確認ください。クリーンアップ処理、NEX サーバーからのログアウト処理、ネットワークのシャットダウン処理、終了処理を順に実行してください。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。アプリケーションで適切にハンドリングしてください。

nn::pia::ResultNetworkConnectionIsLost ネットワークが使用できない状態になっています。無線スイッチOffや、アクセスポイントの障害、ゲームサーバーとの接続の切断などの原因が考えられます。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。クリーンアップ処理、NEX サーバーからのログアウト処理(インターネット通信時限定)、ネットワークのシャットダウン処理を順に実行してください。

nn::pia::ResultGameServerProcessAborted ゲームサーバーに関する処理が異常終了しました。セッション離脱処理、クリーンアップ処理、NEX サーバーからのログアウト処理を順に実行してください。

参照
CreateDummySessionAsync, IsCreateDummySessionCompleted
Result nn::pia::inet::NexDebugSession::GetDestroyDummySessionResult ( ) const

DestroyDummySessionAsync の非同期処理の結果を取得します。

DestroyDummySessionAsync で開始された非同期処理が完了した後、本関数で結果を取得できます。

戻り値
IsSuccess() が真となる Result を返します。失敗した場合、以下の Result を返します。
返るエラーの一覧:

nn::pia::ResultInvalidState ホストではないセッションを削除しようとしました。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultNotFound 削除しようとしたセッションが見つかりませんでした。アプリケーションで適切にハンドリングしてください。

nn::pia::ResultNexInternalError NEX の内部エラーです。nn::pia::Result::GetErrorCode() で取得できるエラーコードは NEX のものになります。エラーコードリストの NEX の項目をご確認ください。クリーンアップ処理、NEX サーバーからのログアウト処理、ネットワークのシャットダウン処理、終了処理を順に実行してください。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。アプリケーションで適切にハンドリングしてください。

nn::pia::ResultNetworkConnectionIsLost ネットワークが使用できない状態になっています。無線スイッチOffや、アクセスポイントの障害、ゲームサーバーとの接続の切断などの原因が考えられます。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。クリーンアップ処理、NEX サーバーからのログアウト処理(インターネット通信時限定)、ネットワークのシャットダウン処理を順に実行してください。

nn::pia::ResultGameServerProcessAborted ゲームサーバーに関する処理が異常終了しました。セッション離脱処理、クリーンアップ処理、NEX サーバーからのログアウト処理を順に実行してください。

参照
DestroyDummySessionAsync, IsDestroyDummySessionCompleted
static NexDebugSession* nn::pia::inet::NexDebugSession::GetInstance ( void  )
inlinestatic

NexDebugSession インスタンスへのポインタを取得します(シングルトンパターン)。

戻り値
インスタンスが作成されていないときは、 NULL ポインタが返ります。
Result nn::pia::inet::NexDebugSession::GetUpdateDummySessionResult ( ) const

UpdateDummySessionAsync の非同期処理の結果を取得します。

UpdateDummySessionAsync で開始された非同期処理が完了した後、本関数で結果を取得できます。

戻り値
IsSuccess() が真となる Result を返します。失敗した場合、以下の Result を返します。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 非同期処理開始時に渡した引数の設定内容が想定外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultInvalidState ホストではないセッションを更新しようとしました。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

nn::pia::ResultNotFound 更新しようとしたセッションが見つかりませんでした。アプリケーションで適切にハンドリングしてください。

nn::pia::ResultNexInternalError NEX の内部エラーです。nn::pia::Result::GetErrorCode() で取得できるエラーコードは NEX のものになります。エラーコードリストの NEX の項目をご確認ください。クリーンアップ処理、NEX サーバーからのログアウト処理、ネットワークのシャットダウン処理、終了処理を順に実行してください。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。アプリケーションで適切にハンドリングしてください。

nn::pia::ResultNetworkConnectionIsLost ネットワークが使用できない状態になっています。無線スイッチOffや、アクセスポイントの障害、ゲームサーバーとの接続の切断などの原因が考えられます。インターネット通信でこのエラーが発生した場合は、ネットワークエラーコードに変換し、エラー・EULA アプレットで表示してください。ですが、ローカル通信時にはエラー・EULA アプレットでエラーコード付きのエラー表示は行わないでください。クリーンアップ処理、NEX サーバーからのログアウト処理(インターネット通信時限定)、ネットワークのシャットダウン処理を順に実行してください。

nn::pia::ResultGameServerProcessAborted ゲームサーバーに関する処理が異常終了しました。セッション離脱処理、クリーンアップ処理、NEX サーバーからのログアウト処理を順に実行してください。

参照
UpdateDummySessionAsync, IsUpdateDummySessionCompleted
bool nn::pia::inet::NexDebugSession::IsCreateDummySessionCompleted ( )

CreateDummySessionAsync の非同期処理の完了をチェックします。

CreateDummySessionAsync で開始された非同期処理は、本関数で完了をチェックできます。

戻り値
非同期処理が完了していた場合は true, 処理中の場合は false が返ります。非同期処理が行われていない場合も false が返ります。
参照
CreateDummySessionAsync, GetCreateDummySessionResult
bool nn::pia::inet::NexDebugSession::IsDestroyDummySessionCompleted ( )

DestroyDummySessionAsync の非同期処理の完了をチェックします。

DestroyDummySessionAsync で開始された非同期処理は、本関数で完了をチェックできます。

戻り値
非同期処理が完了していた場合は true, 処理中の場合は false が返ります。非同期処理が行われていない場合も false が返ります。
参照
DestroyDummySessionAsync, GetDestroyDummySessionResult
bool nn::pia::inet::NexDebugSession::IsUpdateDummySessionCompleted ( )

UpdateDummySessionAsync の非同期処理の完了をチェックします。

UpdateDummySessionAsync で開始された非同期処理は、本関数で完了をチェックできます。

戻り値
非同期処理が完了していた場合は true, 処理中の場合は false が返ります。非同期処理が行われていない場合も false が返ります。
参照
UpdateDummySessionAsync, GetUpdateDummySessionResult
Result nn::pia::inet::NexDebugSession::Startup ( )

NexDebugSession 機能をスタートアップします。

NexFacade::Bind より後に呼び出す必要があります。

戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:
nn::pia::ResultInvalidState 呼び出すタイミングが間違っています。NexFacade のインスタンス作成、NexFacade::Bind が呼び出されているか確認してください。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::NexDebugSession::UpdateDummySessionAsync ( uint32_t  sessionId,
const NexUpdateSessionSetting updateSessionSetting 
)

ダミーセッションの設定更新を行います。

ダミーセッションの設定更新を行う非同期処理を開始します。 開始した処理は nn::pia::common::Scheduler::Dispatch を定期的に呼び出すことで進行します。 処理の完了は IsUpdateDummySessionCompleted でチェックし、結果は GetUpdateDummySessionResult で確認できます。

引数
[in]sessionId設定更新するダミーセッションのセッション ID
[in]updateSessionSettingセッションの更新設定
戻り値
非同期処理の開始に成功すれば、成功の Result が返されます。失敗した場合、以下の Result を返します。
返るエラーの一覧:
nn::pia::ResultInvalidState 呼び出し時に適切な状態ではありませんでした。他の非同期処理が行われていないこと、Startup が呼び出されていること、Session::Startup を呼び出していないか確認してください。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
参照
IsUpdateDummySessionCompleted, GetUpdateDummySessionResult