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

Subscriber 機能を利用するためのクラス。 [詳解]

#include <RendezVous/Services/Jugem/Subscriber/src/Client/SubscriberClient.h>

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

公開メンバ関数

 SubscriberClient ()
 コンストラクタです。 [詳解]
 
virtual ~SubscriberClient ()
 デストラクタです。 [詳解]
 
virtual qBool Bind (Credentials *pCredentials)
 サービスを利用するための証明書を登録します。 [詳解]
 
qBool DeleteContent (ProtocolCallContext *pContext, const qVector< String > &topics, qUnsignedInt64 contentId)
 コンテンツを削除します。 [詳解]
 
qBool GetContent (ProtocolCallContext *pContext, const SubscriberGetContentParam &param, qVector< SubscriberContent > *contents)
 トピックに投稿されたコンテンツを取得します。 [詳解]
 
qBool GetContent (ProtocolCallContext *pContext, const qVector< SubscriberGetContentParam > &params, qVector< qVector< SubscriberContent > > *contentsPerParam)
 複数のトピックに投稿されたコンテンツを一度に取得します。 [詳解]
 
CredentialsGetCredentials () const
 Bind() された Credentials オブジェクトを取得します。 [詳解]
 
qBool PostContent (ProtocolCallContext *pContext, const SubscriberPostContentParam &param, qUnsignedInt64 *contentId)
 コンテンツをトピックに投稿します。 [詳解]
 
void SetDefaultCredentials (Credentials *pCredentials)
 
virtual qBool Unbind ()
 証明書の登録を解除します。 [詳解]
 

詳解

Subscriber 機能を利用するためのクラス。

構築子と解体子

nn::nex::SubscriberClient::SubscriberClient ( )

コンストラクタです。

コンストラクタです。

virtual nn::nex::SubscriberClient::~SubscriberClient ( )
virtual

デストラクタです。

デストラクタです。

関数詳解

virtual qBool nn::nex::SubscriberClient::Bind ( Credentials pCredentials)
virtual

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

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

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


戻り値一覧:

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

false pCredentials に NULL が指定された。

nn::nex::ServiceClientを再実装しています。

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

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

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


戻り値一覧:

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

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

nn::nex::ServiceClientを再実装しています。

qBool nn::nex::SubscriberClient::PostContent ( ProtocolCallContext pContext,
const SubscriberPostContentParam param,
qUnsignedInt64 contentId 
)

コンテンツをトピックに投稿します。

一つのコンテンツを一つもしくは複数のトピックに投稿します。

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

引数
[in,out]pContext呼び出し情報。
[in]param詳細情報。
[out]contentIdコンテンツに割り当てられた ID。この ID はゲームサーバー内で一意となり、投稿ごとに増加されます。


戻り値一覧:

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

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

qBool nn::nex::SubscriberClient::GetContent ( ProtocolCallContext pContext,
const SubscriberGetContentParam param,
qVector< SubscriberContent > *  contents 
)

トピックに投稿されたコンテンツを取得します。

トピックに投稿されたコンテンツをコンテンツ ID 順 (降順) に取得します。 コンテンツ ID は投稿された順に発行され、増加していきますがコンテンツに含まれる投稿日時は数秒前後する可能性があります。 厳密な投稿日時順ではないことにご注意ください。 サーバーでの処理タイミングの差により、過去取得した最大のコンテンツ ID より小さいコンテンツ ID のコンテンツが後で挿入されることがあります。

本関数は例外的にガイドラインに定められた範囲において定期的に呼び出すことが可能です。 呼び出し頻度の制限についてはガイドラインを参照してください。 ポーリングする際は SubscriberGetContentParam::SetMinimumContentId() を用いて前回取得したコンテンツを再度取得しないようにし、 一つのトピックから一度に取得する件数を 20 件以内にしてください。 取得した情報を利用しない場面に遷移した場合などはポーリングを停止し、できる限り不要なアクセスを避けるようにしてください。

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

引数
[in,out]pContext呼び出し情報。
[in]param詳細情報。
[out]contents取得したコンテンツ。


戻り値一覧:

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

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

qBool nn::nex::SubscriberClient::GetContent ( ProtocolCallContext pContext,
const qVector< SubscriberGetContentParam > &  params,
qVector< qVector< SubscriberContent > > *  contentsPerParam 
)

複数のトピックに投稿されたコンテンツを一度に取得します。

トピックに投稿されたコンテンツをコンテンツ ID 順 (降順) に取得します。 コンテンツ ID は投稿された順に発行され、増加していきますがコンテンツに含まれる投稿日時は数秒前後する可能性があります。 厳密な投稿日時順ではないことにご注意ください。 サーバーでの処理タイミングの差により、過去取得した最大のコンテンツ ID より小さいコンテンツ ID のコンテンツが後で挿入されることがあります。

本関数は例外的にガイドラインに定められた範囲において定期的に呼び出すことが可能です。 呼び出し頻度の制限についてはガイドラインを参照してください。 ポーリングする際は SubscriberGetContentParam::SetMinimumContentId() を用いて前回取得したコンテンツを再度取得しないようにし、 一つのトピックから一度に取得する件数を 20 件以内にしてください。 取得した情報を利用しない場面に遷移した場合などはポーリングを停止し、できる限り不要なアクセスを避けるようにしてください。

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

引数
[in,out]pContext呼び出し情報。
[in]params詳細情報。
[out]contentsPerParam取得したコンテンツのリスト。コンテンツのリストの順は指定したparamsの順に対応します。


戻り値一覧:

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

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

qBool nn::nex::SubscriberClient::DeleteContent ( ProtocolCallContext pContext,
const qVector< String > &  topics,
qUnsignedInt64  contentId 
)

コンテンツを削除します。

指定したトピックに存在するコンテンツを削除します。 投稿時に複数のトピックを指定した場合、全てのトピックからコンテンツを削除するにはその全てのトピックを指定する必要があります。 投稿したトピックの内、一部のトピックを指定しなかった場合はそのトピックのコンテンツは削除されません。 自分自身が投稿したコンテンツのみ削除できます。 指定したトピックにコンテンツが見つからない場合は無視され成功の結果になります。

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

引数
[in,out]pContext呼び出し情報。
[in]topics削除元のトピック。
[out]contentId削除するコンテンツ ID。


戻り値一覧:

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.
Credentials* nn::nex::ServiceClient::GetCredentials ( ) const
inherited

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

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