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

NEX ライブラリのファサード(facade、インターフェースラッパー)クラスです。 [詳細]

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

構成

struct  LoginInfo
 ログインした NEX ゲームサーバーの情報 [詳細]
 

Public メソッド

Result AddToBlockListAsync (PrincipalId *pPrincipalIdArray, uint32_t principalIdArraySize)
 ブロックリストにユーザーを追加する非同期処理を開始します。
 
Result Bind (const LoginInfo *pLoginInfo)
 ログインしたゲームサーバーの情報を登録します。
 
Result ClearBlockListAsync ()
 ブロックリストをクリアする非同期処理を開始します。
 
Result GetAddToBlockListResult () const
 AddToBlockListAsync の非同期処理の結果を取得します。
 
Result GetBlockList (PrincipalId *pPrincipalIdArray, uint32_t principalIdArraySize, uint32_t *pBlockListSize)
 ブロックリストに登録されているユーザーを取得します。
 
Result GetClearBlockListResult () const
 ClearBlockListAsync の非同期処理の結果を取得します。
 
PrincipalId GetLocalPrincipalId () const
 自分のプリンシパル ID を取得します。
 
nat::Filtering GetNatPropertyFiltering () const
 自分自身の NAT フィルタリングタイプを取得します。
 
uint16_t GetNatPropertyInterfacePort () const
 自分自身の NAT の LAN 側のポートを取得します。
 
nat::Mapping GetNatPropertyMapping () const
 自分自身の NAT ポートマッピングタイプを取得します。
 
uint32_t GetNatPropertyPortIncrement () const
 自分自身の NAT ポートインクリメントを取得します。
 
uint16_t GetNatPropertyPublicPort () const
 自分自身の NAT のインターネット側のポートを取得します。
 
Result GetRemoveFromBlockListResult () const
 RemoveFromBlockListAsync の非同期処理の結果を取得します。
 
Result GetRequestBlockListResult () const
 RequestBlockListAsync の非同期処理の結果を取得します。
 
Result GetRetrieveNotificationDataResult () const
 RetrieveNotificationDataAsync の非同期処理の結果を取得します。
 
Result GetUpdateNotificationDataResult () const
 UpdateNotificationDataAsync の非同期処理の結果を取得します。
 
bool IsAddToBlockListCompleted () const
 AddToBlockListAsync の非同期処理の完了をチェックします。
 
bool IsClearBlockListCompleted () const
 ClearBlockListAsync の非同期処理の完了をチェックします。
 
bool IsRemoveFromBlockListCompleted () const
 RemoveFromBlockListAsync の非同期処理の完了をチェックします。
 
bool IsRequestBlockListCompleted () const
 RequestBlockListAsync の非同期処理の完了をチェックします。
 
bool IsRetrieveNotificationDataCompleted () const
 RetrieveNotificationDataAsync の非同期処理の完了をチェックします。
 
bool IsUpdateNotificationDataCompleted () const
 UpdateNotificationDataAsync の非同期処理の完了をチェックします。
 
Result RemoveFromBlockListAsync (PrincipalId *pPrincipalIdArray, uint32_t principalIdArraySize)
 ブロックリストから指定したユーザーを削除する非同期処理を開始します。。
 
Result RequestBlockListAsync ()
 ブロックリストに登録しているユーザーを取得する非同期処理を開始します。
 
Result RetrieveNotificationDataAsync (uint8_t gameNotificationTypeBitMask, nn::nex::qList< nn::nex::NotificationEvent > *pRetrievedEventList)
 ゲームサーバーに通知されたゲーム固有のイベントを取得します。
 
void Unbind ()
 登録したゲームサーバーの情報を削除します。
 
Result UpdateNotificationDataAsync (nn::nex::NotificationEvents::NotificationEvents gameNotificationType, uint32_t param1, uint32_t param2, const common::String &strParam)
 ゲーム固有のイベントをゲームサーバーに通知します。
 

Static Public メソッド

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

説明

NEX ライブラリのファサード(facade、インターフェースラッパー)クラスです。

nn::pia::inet::Nex*クラス群のファサードではなく、NEX ライブラリのクラス群のファサードクラスになります。

関数

Result nn::pia::inet::NexFacade::AddToBlockListAsync ( PrincipalId pPrincipalIdArray,
uint32_t  principalIdArraySize 
)

ブロックリストにユーザーを追加する非同期処理を開始します。

開始した処理は common::Scheduler::Dispatch を定期的に呼び出すことで進行します。また、NEX のディスパッチ関数も同様に定期的に呼び出す必要があります。 処理の完了は IsAddToBlockListCompleted でチェックし、結果は GetAddToBlockListResult で確認できます。
既にフレンド関係が成立している場合は登録できません。また、既にブロックリストに追加されているユーザーは無視されます。 ブロックリスト登録後にフレンド関係が成立しても、自動的にブロックリストから削除されることはありません。

引数
[in]pPrincipalIdArrayブロックリストに登録するユーザーのプリンシパル ID を格納した配列のポインタ。
[in]principalIdArraySizeブロックリストに登録するユーザーのプリンシパル ID を格納した配列のサイズ。配列の最大長は 100 です。
戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

参照
IsAddToBlockListCompleted, GetAddToBlockListResult
Result nn::pia::inet::NexFacade::Bind ( const LoginInfo pLoginInfo)

ログインしたゲームサーバーの情報を登録します。

本関数は NEX ゲームサーバーへのログインに成功した際の nn::nex::NgsFacade クラスのインスタンス、ゲームサーバー ID、アクセスキー を Pia ライブラリに登録します。 NEX ゲームサーバーにログインしてから NexFacade::Startup を呼び出すまでの間に呼び出す必要があります。

引数
[in]pLoginInfoログインした NEX ゲームサーバー情報 LoginInfo のポインタを指定します。
戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
参照
Unbind, Startup
Result nn::pia::inet::NexFacade::ClearBlockListAsync ( )

ブロックリストをクリアする非同期処理を開始します。

開始した処理は common::Scheduler::Dispatch を定期的に呼び出すことで進行します。また、NEX のディスパッチ関数も同様に定期的に呼び出す必要があります。 処理の完了は IsClearBlockListCompleted でチェックし、結果は GetClearBlockListResult で確認できます。

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

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

参照
IsClearBlockListCompleted, GetClearBlockListResult
static Result nn::pia::inet::NexFacade::CreateInstance ( void  )
static

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

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

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

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

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

static void nn::pia::inet::NexFacade::DestroyInstance ( void  )
static

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

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

Result nn::pia::inet::NexFacade::GetAddToBlockListResult ( ) const

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

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

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

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

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

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

参照
AddToBlockListAsync, IsAddToBlockListCompleted
Result nn::pia::inet::NexFacade::GetBlockList ( PrincipalId pPrincipalIdArray,
uint32_t  principalIdArraySize,
uint32_t *  pBlockListSize 
)

ブロックリストに登録されているユーザーを取得します。

ブロックリストの情報取得は RequestBlockListAsync で行う必要があります。

引数
[in]pPrincipalIdArrayブロックリストに登録されているユーザーのプリンシパル ID をコピーする配列のポインタ。
[in]principalIdArraySizeブロックリストに登録されているユーザーのプリンシパル ID をコピーする配列のサイズ。配列の最大長は 100 です。
[out]pBlockListSize引数に指定した配列にプリンシパル ID をコピーした回数を格納する変数のポインタ。
戻り値
IsSuccess() が真となる Result を返します。失敗した場合、以下の Result を返します。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

参照
RequestBlockListAsync
Result nn::pia::inet::NexFacade::GetClearBlockListResult ( ) const

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

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

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

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

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

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

参照
ClearBlockListAsync, IsClearBlockListCompleted
static NexFacade* nn::pia::inet::NexFacade::GetInstance ( void  )
inlinestatic

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

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

自分のプリンシパル ID を取得します。

プリンシパル ID はゲームサーバーにログインし、Bind() 実行後に取得できるようになります。

戻り値
自分のプリンシパル ID を返します。
nat::Filtering nn::pia::inet::NexFacade::GetNatPropertyFiltering ( ) const

自分自身の NAT フィルタリングタイプを取得します。

自分自身の NAT フィルタリングタイプを取得します。 NexFacade::StartNatSessionAsync の非同期処理が完了した後に正しい値を取得できます。

戻り値
NAT フィルタリング
uint16_t nn::pia::inet::NexFacade::GetNatPropertyInterfacePort ( ) const

自分自身の NAT の LAN 側のポートを取得します。

自分自身の NAT の LAN 側のポートを取得します。 NexFacade::StartNatSessionAsync の非同期処理が完了した後に正しい値を取得できます。

戻り値
NAT の LAN 側のポート
nat::Mapping nn::pia::inet::NexFacade::GetNatPropertyMapping ( ) const

自分自身の NAT ポートマッピングタイプを取得します。

自分自身の NAT ポートマッピングタイプを取得します。 NexFacade::StartNatSessionAsync の非同期処理が完了した後に正しい値を取得できます。

戻り値
NAT ポートマッピングタイプ
uint32_t nn::pia::inet::NexFacade::GetNatPropertyPortIncrement ( ) const

自分自身の NAT ポートインクリメントを取得します。

自分自身の NAT ポートインクリメントを取得します。 NexFacade::StartNatSessionAsync の非同期処理が完了した後に正しい値を取得できます。

戻り値
NAT ポートインクリメント
uint16_t nn::pia::inet::NexFacade::GetNatPropertyPublicPort ( ) const

自分自身の NAT のインターネット側のポートを取得します。

自分自身の NAT のインターネット側のポートを取得します。 NexFacade::StartNatSessionAsync の非同期処理が完了した後に正しい値を取得できます。

戻り値
NAT のインターネット側のポート
Result nn::pia::inet::NexFacade::GetRemoveFromBlockListResult ( ) const

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

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

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

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

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

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

参照
RemoveFromBlockListAsync, IsRemoveFromBlockListCompleted
Result nn::pia::inet::NexFacade::GetRequestBlockListResult ( ) const

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

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

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

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

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

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

参照
RequestBlockListAsync, IsRequestBlockListCompleted
Result nn::pia::inet::NexFacade::GetRetrieveNotificationDataResult ( ) const

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

RetrieveNotificationDataAsync を呼び出し、IsRetrieveNotificationDataCompleted で処理が完了した後、本関数で結果を取得します。

戻り値
RetrieveNotificationDataAsync の非同期処理の結果を返します。 処理が完了した場合、以下を返します。
返るエラーの一覧:

ResultSuccess 非同期処理が成功しました。

nn::pia::ResultInvalidState RetrieveNotificationDataAsync を呼び出すタイミングが間違っているか、非同期処理が完了していません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

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

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

Result nn::pia::inet::NexFacade::GetUpdateNotificationDataResult ( ) const

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

UpdateNotificationDataAsync を呼び出し、IsUpdateNotificationDataCompleted で処理が完了した後、本関数で結果を取得します。

戻り値
UpdateNotificationDataAsync の非同期処理の結果を返します。 処理が完了した場合、以下を返します。
返るエラーの一覧:

ResultSuccess 非同期処理が成功しました。

nn::pia::ResultInvalidState UpdateNotificationDataAsync を呼び出すタイミングが間違っているか、非同期処理が完了していません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

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

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

bool nn::pia::inet::NexFacade::IsAddToBlockListCompleted ( ) const

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

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

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

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

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

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

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

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

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

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

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

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

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

RetrieveNotificationDataAsync を呼び出した後、本関数で非同期処理の完了をチェックします。

戻り値
非同期処理が完了していた場合は true, 処理中の場合は false が返ります。
bool nn::pia::inet::NexFacade::IsUpdateNotificationDataCompleted ( ) const

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

UpdateNotificationDataAsync を呼び出した後、本関数で非同期処理の完了をチェックします。

戻り値
非同期処理が完了していた場合は true, 処理中の場合は false が返ります。
Result nn::pia::inet::NexFacade::RemoveFromBlockListAsync ( PrincipalId pPrincipalIdArray,
uint32_t  principalIdArraySize 
)

ブロックリストから指定したユーザーを削除する非同期処理を開始します。。

開始した処理は common::Scheduler::Dispatch を定期的に呼び出すことで進行します。また、NEX のディスパッチ関数も同様に定期的に呼び出す必要があります。 処理の完了は IsRemoveFromBlockListCompleted でチェックし、結果は GetRemoveFromBlockListResult で確認できます。

引数
[in]pPrincipalIdArrayブロックリストから削除するユーザーのプリンシパル ID を格納した配列のポインタ。
[in]principalIdArraySizeブロックリストから削除するユーザーのプリンシパル ID を格納した配列のサイズ。配列の最大長は 100 です。
戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

参照
IsRemoveFromBlockListCompleted, GetRemoveFromBlockListResult
Result nn::pia::inet::NexFacade::RequestBlockListAsync ( )

ブロックリストに登録しているユーザーを取得する非同期処理を開始します。

開始した処理は common::Scheduler::Dispatch を定期的に呼び出すことで進行します。また、NEX のディスパッチ関数も同様に定期的に呼び出す必要があります。 処理の完了は IsRequestBlockListCompleted でチェックし、結果は GetRequestBlockListResult で確認できます。 非同期処理が成功していた場合は、GetBlockList でブロックリストの登録ユーザーを取得できます。

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

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

参照
IsRequestBlockListCompleted, GetRequestBlockListResult, GetBlockList
Result nn::pia::inet::NexFacade::RetrieveNotificationDataAsync ( uint8_t  gameNotificationTypeBitMask,
nn::nex::qList< nn::nex::NotificationEvent > *  pRetrievedEventList 
)

ゲームサーバーに通知されたゲーム固有のイベントを取得します。

同じゲームサーバーにログインしているフレンドから通知された、ゲームが独自に定義したイベントを取得します。 ゲームサーバーにログインし、Bind の呼び出しから Unbind の呼び出しまでの間に呼び出し可能です。 通常、イベントの取得はイベントハンドラで取得し、本関数によるイベント取得はログイン時のみとします。
非同期処理中に nn::nex::MatchmakeExtensionClient::GetFriendNotificationData を呼び出します。
この API は非推奨のため、本関数も非推奨となります。

引数
[in]gameNotificationTypeBitMask取得対象とするゲーム定義のイベントタイプを示すビットマスクを指定します。N ビット目が nn::nex::NotificationEvents::GameNotificationEventN にあたります。
[out]pRetrievedEventList取得したイベントのリストを格納先を指定します。指定したリストは非同期処理完了までインスタンスを保持する必要があります。
戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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

void nn::pia::inet::NexFacade::Unbind ( )

登録したゲームサーバーの情報を削除します。

本関数は NEX ゲームサーバーへのログインに成功した際の nn::nex::NgsFacade クラスのインスタンス、ゲームサーバー ID の登録情報を Pia ライブラリから削除します。 NexFacade::Cleanup を呼び出してから NEX ゲームサーバーからログアウトするまでの間に呼び出す必要があります。

参照
Bind, Startup
Result nn::pia::inet::NexFacade::UpdateNotificationDataAsync ( nn::nex::NotificationEvents::NotificationEvents  gameNotificationType,
uint32_t  param1,
uint32_t  param2,
const common::String strParam 
)

ゲーム固有のイベントをゲームサーバーに通知します。

同じゲームサーバーにログインしているフレンドに対して、ゲームが独自に定義したイベントを通知します。 ゲームサーバーにログインし、Bind の呼び出しから Unbind の呼び出しまでの間に呼び出し可能です。 イベント通知は 1 分間に 10 回の頻度を越えて呼び出してはいけません。
非同期処理中に nn::nex::MatchmakeExtensionClient::UpdateNotificationData を呼び出します。
この API は非推奨のため、本関数も非推奨となります。

引数
[in]gameNotificationTypeゲーム定義のイベントタイプ(nn::nex::NotificationEvents::GameNotificationEvent1 ~ 8)を指定します。
[in]param1イベントのパラメータを指定します。
[in]param2イベントのパラメータを指定します。
[in]strParamイベントのパラメータ(文字列)を指定します。文字列長は 256 以内です。
戻り値
関数の実行結果を返します。 処理が失敗した場合、以下を返します。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

nn::pia::ResultInvalidArgument 引数に誤りがあります。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

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