CTR NEX API Reference
nn::nex::UtilityClient クラス

NEX サービス全体で利用することのある機能をまとめたクラスです。 [詳解]

#include <RendezVous/Services/Jugem/Utility/src/Client/UtilityClient.h>

+ nn::nex::UtilityClient の継承関係図

公開メンバ関数

 UtilityClient ()
 コンストラクタです。
 
virtual ~UtilityClient ()
 デストラクタです。
 
qBool AcquireNexUniqueId (ProtocolCallContext *pContext, UniqueId *pNexUniqueId)
 NEX ユニーク ID を取得します。 [詳解]
 
qBool AcquireNexUniqueIdWithPassword (ProtocolCallContext *pContext, UniqueIdInfo *pUniqueIdInfo)
 NEX ユニーク ID とパスワードを取得します。 [詳解]
 
qBool AssociateNexUniqueIdWithMyPrincipalId (ProtocolCallContext *pContext, const UniqueIdInfo &uniqueIdInfo)
 1つの NEX ユニーク ID を自分のプリンシパル ID に関連付けます。 [詳解]
 
qBool AssociateNexUniqueIdWithMyPrincipalId (ProtocolCallContext *pContext, const qVector< UniqueIdInfo > &uniqueIdInfo)
 複数の NEX ユニーク ID を自分のプリンシパル ID に関連付けます。 [詳解]
 
virtual qBool Bind (Credentials *pCredentials)
 サービスを利用するための証明書を登録します。 [詳解]
 
qBool GetAssociatedNexUniqueIdWithMyPrincipalId (ProtocolCallContext *pContext, UniqueIdInfo *pUniqueIdInfo)
 自分のプリンシパル ID に関連付いたプライマリ関連 NEX ユニーク ID を取得します。 [詳解]
 
qBool GetAssociatedNexUniqueIdWithMyPrincipalId (ProtocolCallContext *pContext, qVector< UniqueIdInfo > *pUniqueIdInfo)
 自分のプリンシパル ID に関連付いた NEX ユニーク ID を取得します。 [詳解]
 
CredentialsGetCredentials () const
 Bind() された Credentials オブジェクトを取得します。 [詳解]
 
qBool GetIntegerSettings (ProtocolCallContext *pContext, qUnsignedInt32 integerSettingIndex, qMap< qUnsignedInt16, qInt32 > *pIntegerSettings)
 アプリケーション固有の整数の設定値を取得します。 [詳解]
 
void SetDefaultCredentials (Credentials *pCredentials)
 
virtual qBool Unbind ()
 証明書の登録を解除します。 [詳解]
 

静的公開メンバ関数

static qBool IsValidNexUniqueId (UniqueId nexUniqueId)
 NEX ユニーク ID が妥当かどうかを判定します。 [詳解]
 

詳解

NEX サービス全体で利用することのある機能をまとめたクラスです。

関数詳解

qBool nn::nex::UtilityClient::AcquireNexUniqueId ( ProtocolCallContext pContext,
UniqueId pNexUniqueId 
)

NEX ユニーク ID を取得します。

NEX ユニーク ID は、本関数を呼び出す度に新しい値が取得されます。
取得したユニーク ID はセーブ領域に保存し、保存されていない場合にのみ本関数を呼び出すようにして下さい。

引数
[in,out]pContext呼び出し情報。
[out]pNexUniqueIdNEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::UtilityClient::AcquireNexUniqueIdWithPassword ( ProtocolCallContext pContext,
UniqueIdInfo pUniqueIdInfo 
)

NEX ユニーク ID とパスワードを取得します。

NEX ユニーク ID とパスワードは、本関数を呼び出す度に新しい値が取得されます。
取得したユニーク ID とパスワードはセーブ領域に保存し、保存されていない場合にのみ本関数を呼び出すようにして下さい。

引数
[in,out]pContext呼び出し情報。
[out]pUniqueIdInfoNEX ユニーク ID 情報


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

static qBool nn::nex::UtilityClient::IsValidNexUniqueId ( UniqueId  nexUniqueId)
static

NEX ユニーク ID が妥当かどうかを判定します。

引数
[in]nexUniqueIdNEX ユニーク ID。
戻り値
妥当な場合は true 、不正な場合は false が返ります。
qBool nn::nex::UtilityClient::AssociateNexUniqueIdWithMyPrincipalId ( ProtocolCallContext pContext,
const UniqueIdInfo uniqueIdInfo 
)

1つの NEX ユニーク ID を自分のプリンシパル ID に関連付けます。

uniqueIdInfo に指定した NEX ユニーク ID をプライマリ関連 NEX ユニーク ID として登録し、 その他の紐付を解除します。 NEX ユニーク ID に INVALID_UNIQUEID を指定すると全ての紐付が解除されます。 既に他の人に紐づいている NEX ユニーク ID を指定する場合、その人がオフライン状態である必要があります。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]uniqueIdInfo関連付ける NEX ユニーク ID、パスワード


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::UtilityClient::AssociateNexUniqueIdWithMyPrincipalId ( ProtocolCallContext pContext,
const qVector< UniqueIdInfo > &  uniqueIdInfo 
)

複数の NEX ユニーク ID を自分のプリンシパル ID に関連付けます。

uniqueIdInfo に空のリストを指定すると全ての紐付が解除されます。 uniqueIdInfo の先頭がプライマリ関連 NEX ユニーク ID となります。 既に他の人に紐づいている NEX ユニーク ID を指定する場合、その人がオフライン状態である必要があります。

非同期処理の結果、以下の Result が返ることがあります。 エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]uniqueIdInfo関連付ける NEX ユニーク ID、パスワード。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::UtilityClient::GetAssociatedNexUniqueIdWithMyPrincipalId ( ProtocolCallContext pContext,
UniqueIdInfo pUniqueIdInfo 
)

自分のプリンシパル ID に関連付いたプライマリ関連 NEX ユニーク ID を取得します。

引数
[in,out]pContext呼び出し情報。
[out]pUniqueIdInfo自分のプリンシパル ID に関連付いたプライマリ関連 NEX ユニーク ID、パスワード。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::UtilityClient::GetAssociatedNexUniqueIdWithMyPrincipalId ( ProtocolCallContext pContext,
qVector< UniqueIdInfo > *  pUniqueIdInfo 
)

自分のプリンシパル ID に関連付いた NEX ユニーク ID を取得します。

引数
[in,out]pContext呼び出し情報。
[out]pUniqueIdInfo自分のプリンシパル ID に関連付いた NEX ユニーク ID、パスワード。先頭がプライマリ関連 NEX ユニーク ID。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

qBool nn::nex::UtilityClient::GetIntegerSettings ( ProtocolCallContext pContext,
qUnsignedInt32  integerSettingIndex,
qMap< qUnsignedInt16, qInt32 > *  pIntegerSettings 
)

アプリケーション固有の整数の設定値を取得します。

サーバ側に設定されたアプリケーション固有の整数の設定値を取得します。

引数
[in,out]pContext呼び出し情報。
[in]integerSettingIndex設定インデックス。
[out]pIntegerSettingsサーバ側に設定されたアプリケーション固有の整数の設定値。


戻り値一覧:

true 非同期処理の開始に成功。

false 指定した pContext の状態が CallContext::CallInProgress となっており非同期処理を開始出来ない。 これは他の非同期処理で使用中であることを示します。 プログラミングエラーであるため、このケースはリリースビルド以外では内部で Assert により停止します。

void nn::nex::ServiceClient::SetDefaultCredentials ( Credentials pCredentials)
inherited
引数
pCredentialsThe default Credentials for this service.
注釈
It is up to each ServiceClient to use this method to set the current Credentials in each of his protocols.
virtual qBool nn::nex::ServiceClient::Bind ( Credentials pCredentials)
virtualinherited

サービスを利用するための証明書を登録します。

サービスを利用するための証明書をセットします。 機能を利用する前にセットする必要があります。NgsFacade::Login() の非同期処理に成功後、 NgsFacade::GetCredentials() で取得した証明書を引数に指定してください。 Bind() で証明書をセットした後もう一度 Bind() を呼び出すと証明書を差し替える事ができます。

引数
[in]pCredentialsサービスにアクセスするための証明書。


戻り値一覧:

true 成功。pCredentials が NULL でない場合は必ず成功します。

false pCredentials に NULL が指定された。

virtual qBool nn::nex::ServiceClient::Unbind ( )
virtualinherited

証明書の登録を解除します。

Bind() でセットされた証明書を解除します。Bind() が呼び出されていなくても本関数を呼び出すことができます。 本オブジェクトを破棄する際に自動的に Unbind() と同等の処理行われるため、明示的に呼び出す必要はありません。


戻り値一覧:

true 証明書の解除を行った。

false Bind() が行われていないため何も行わなかった。

Credentials* nn::nex::ServiceClient::GetCredentials ( ) const
inherited

Bind() された Credentials オブジェクトを取得します。

戻り値
Bind() された Credentials オブジェクト。Bind() されていない場合、NULL を返します。