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

呼び出しコンテキストのクラスです。 [詳細]

+ nn::pia::common::CallContextに対する継承グラフ

Public 型

typedef void(* CompletionCallback )(Result result, void *pUserArg)
 非同期処理の完了時に実行するコールバック関数の typedef です。
 

Public メソッド

 CallContext (void)
 コンストラクタです。
 
 ~CallContext (void)
 デストラクタです。
 
void Cancel (void)
 非同期処理のキャンセルをリクエストします。
 
Result GetResult () const
 非同期処理の実行結果の Result 値を取得します。
 
bool IsCompleted () const
 非同期処理が終了したかどうかを判定します。
 
bool IsInProgress () const
 非同期処理が進行中であるかどうかを判定します。
 
void RegisterCompletionCallback (CompletionCallback pCallback, void *pUserArg=NULL)
 非同期処理の完了時に実行するコールバック関数を設定します。
 

説明

呼び出しコンテキストのクラスです。

呼び出しコンテキストは、主に非同期関数の実行状態を記録するのに用いられます。

型定義

typedef void(* nn::pia::common::CallContext::CompletionCallback)(Result result, void *pUserArg)

非同期処理の完了時に実行するコールバック関数の typedef です。

非同期処理完了時にコールバック関数が呼び出されるようにするには、 CompletionCallback を RegisterCompletionCallback() で登録します。

参照
RegisterCompletionCallback

コンストラクタとデストラクタ

nn::pia::common::CallContext::CallContext ( void  )

コンストラクタです。

状態は State_Available にセットされます。

nn::pia::common::CallContext::~CallContext ( void  )

デストラクタです。

デストラクタ呼び出し時に、CallContext の状態が State_CallInProgress であった場合には、アサート停止します。

関数

void nn::pia::common::CallContext::Cancel ( void  )

非同期処理のキャンセルをリクエストします。

ただし、この API 呼び出しによって即座に非同期処理がキャンセルされるわけでは ないことに注意してください。 この API 呼び出し後は、定期的に IsCompleted() で終了状態をチェックし、 true を返すまで待つ必要があります。

参照
IsCompleted, GetResult
Result nn::pia::common::CallContext::GetResult ( ) const
inline

非同期処理の実行結果の Result 値を取得します。

戻り値
非同期処理の実行結果の Result 値。
bool nn::pia::common::CallContext::IsCompleted ( ) const
inline

非同期処理が終了したかどうかを判定します。

戻り値
非同期処理が終了した状態(失敗して終了した状態も含みます)であれば true 、そうでなければ false を返します。
bool nn::pia::common::CallContext::IsInProgress ( ) const
inline

非同期処理が進行中であるかどうかを判定します。

戻り値
非同期処理が進行中の状態であれば true 、そうでなければ false を返します。
void nn::pia::common::CallContext::RegisterCompletionCallback ( CompletionCallback  pCallback,
void *  pUserArg = NULL 
)

非同期処理の完了時に実行するコールバック関数を設定します。

引数
[in]pCallback非同期処理完了時に呼び出されるコールバック関数へのポインタです。
[in]pUserArgpCallback を呼び出す際に第2引数に与える値を指定します。
参照
CompletionCallback