CTR NEX API Reference
nn::nex::ServiceClient クラスabstract

ゲームサーバーとの通信を行う Client 機能のルートクラスです。 [詳解]

#include <RendezVous/Core/src/Client/ServiceClient.h>

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

公開メンバ関数

 ServiceClient (qUnsignedInt32 uiServiceID)
 
virtual ~ServiceClient ()
 Only classes that inherit from the ServiceClient object should be destroyed and not the ServiceClient object itself. [詳解]
 
virtual qBool Bind (Credentials *pCredentials)
 サービスを利用するための証明書を登録します。 [詳解]
 
CredentialsGetCredentials () const
 Bind() された Credentials オブジェクトを取得します。 [詳解]
 
void SetDefaultCredentials (Credentials *pCredentials)
 
virtual qBool Unbind ()
 証明書の登録を解除します。 [詳解]
 

詳解

ゲームサーバーとの通信を行う Client 機能のルートクラスです。

構築子と解体子

nn::nex::ServiceClient::ServiceClient ( qUnsignedInt32  uiServiceID)
引数
uiServiceIDThe ServiceID of the service.
注釈
Only classes that inherit from the ServiceClient object should be instantiated and not the ServiceClient object itself. ServiceClient objects should only be created after a client has logged in to the lobby (via RendezVous::Login). Refer to the Integration page for further details as to the correct order of calls.
virtual nn::nex::ServiceClient::~ServiceClient ( )
virtual

Only classes that inherit from the ServiceClient object should be destroyed and not the ServiceClient object itself.

ServiceClient objects should be destroyed before the client logs out of the lobby (via RendezVous::Logout). Refer to the Integration page for further details as to the correct order of calls.

関数詳解

void nn::nex::ServiceClient::SetDefaultCredentials ( Credentials pCredentials)
引数
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)
virtual

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

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

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


戻り値一覧:

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

false pCredentials に NULL が指定された。

nn::nex::MatchmakeExtensionClient, nn::nex::RankingClient, nn::nex::DebugClient, nn::nex::ServiceItemInternalClient, nn::nex::MatchmakeRefereeClient, nn::nex::DataStoreLogicServerClient, nn::nex::Ranking2Client, nn::nex::SubscriberClient, nn::nex::UtilityClientで再実装されています。

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

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

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


戻り値一覧:

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

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

nn::nex::MatchmakeExtensionClient, nn::nex::RankingClient, nn::nex::DebugClient, nn::nex::ServiceItemInternalClient, nn::nex::MatchmakeRefereeClient, nn::nex::DataStoreLogicServerClient, nn::nex::Ranking2Client, nn::nex::SubscriberClient, nn::nex::UtilityClientで再実装されています。

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

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

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