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

マッチメイク機能を利用するためのクラス。 [詳解]

#include <RendezVous/Services/Jugem/Matchmake/src/Client/MatchmakeExtensionClient.h>

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

公開メンバ関数

 MatchmakeExtensionClient ()
 コンストラクタです。 [詳解]
 
virtual ~MatchmakeExtensionClient ()
 デストラクタです。 [詳解]
 
qBool AddToBlackList (ProtocolCallContext *pContext, const qList< PrincipalID > &principalIdList)
 ブロックリストにユーザーを追加します。推奨されません。 [詳解]
 
qBool AddToBlockList (ProtocolCallContext *pContext, const qList< PrincipalID > &principalIdList)
 ブロックリストにユーザーを追加します。 [詳解]
 
qBool AutoMatchmake (ProtocolCallContext *pContext, const AutoMatchmakeParam &autoMatchmakeParam, MatchmakeSession *joinedMatchmakingSession)
 自動的にマッチメイクセッションを検索し、参加します。 [詳解]
 
virtual qBool Bind (Credentials *pCredentials)
 サービスを利用するための証明書を登録します。 [詳解]
 
qBool BrowseMatchmakeSession (ProtocolCallContext *pContext, const MatchmakeSessionSearchCriteria &searchCriteria, qList< MatchmakeSession > *lstMatchmakeSession)
 マッチメイクセッションを検索します。 [詳解]
 
qBool BrowseMatchmakeSession (ProtocolCallContext *pContext, const MatchmakeSessionSearchCriteria &searchCriteria, qList< MatchmakeSession > *lstMatchmakeSession, qList< GatheringURLs > *lstGatheringURLs)
 マッチメイクセッションを検索します。 [詳解]
 
qBool BrowseMatchmakeSession (ProtocolCallContext *pContext, const MatchmakeSessionSearchCriteria &searchCriteria, const ResultRange &resultRange, qList< MatchmakeSession > *lstMatchmakeSession)
 マッチメイクセッションを検索します。推奨されません。 [詳解]
 
qBool BrowseMatchmakeSession (ProtocolCallContext *pContext, const MatchmakeSessionSearchCriteria &searchCriteria, const ResultRange &resultRange, qList< MatchmakeSession > *lstMatchmakeSession, qList< GatheringURLs > *lstGatheringURLs)
 マッチメイクセッションを検索します。推奨されません。 [詳解]
 
qBool ClearBlackList (ProtocolCallContext *pContext)
 自分がサーバーに登録したブロックリストを全て削除します。推奨されません。 [詳解]
 
qBool ClearBlockList (ProtocolCallContext *pContext)
 自分がサーバーに登録したブロックリストを全て削除します。 [詳解]
 
qBool ClearMatchmakeSessionSystemPassword (ProtocolCallContext *pContext, GatheringID gatheringId)
 マッチメイクセッションに設定されたマッチメイクセッションシステムパスワードを解除します。 [詳解]
 
qBool CloseParticipation (ProtocolCallContext *pContext, GatheringID gid)
 マッチメイクセッションへの参加を締め切ります。 [詳解]
 
qBool CreateMatchmakeSession (ProtocolCallContext *pContext, const CreateMatchmakeSessionParam &createMatchmakeSessionParam, MatchmakeSession *joinedMatchmakingSession)
 マッチメイクセッションを作成し、参加します。 [詳解]
 
qBool CreatePersistentGathering (ProtocolCallContext *pContext, const PersistentGathering &persistentGathering, GatheringID *pGatheringId, const String &strMessage=NEX_T(""))
 永続ギャザリングを登録します [詳解]
 
qBool DebugNotifyEvent (ProtocolCallContext *pContext, PrincipalID pid, qUnsignedInt32 type, qUnsignedInt32 subType, qUnsignedInt64 param1, qUnsignedInt64 param2, const String &stringParam)
 指定PIDに任意のイベントを送ります。デバッグ用機能です。製品では使用しないでください。 [詳解]
 
qBool EndParticipation (ProtocolCallContext *pContext, GatheringID id, const String &strMessage=NEX_T(""))
 ギャザリング(マッチメイクセッション)から退出します。 [詳解]
 
qBool FindByID (ProtocolCallContext *pContext, const qList< GatheringID > &lstID, qList< GatheringHolder > *plstGatherings)
 ギャザリングをIDで検索します [詳解]
 
qBool FindByID (ProtocolCallContext *pContext, GatheringID id, GatheringHolder *pGathering)
 ギャザリングをIDで検索します [詳解]
 
qBool FindByOwner (ProtocolCallContext *pContext, PrincipalID pidOwner, const ResultRange &resultRange, qList< GatheringHolder > *plstGatherings)
 ギャザリングのオーナーの PrincipalId で検索します。 [詳解]
 
qBool FindMatchmakeSessionByGatheringId (ProtocolCallContext *pContext, const qList< GatheringID > &gatheringIdList, qList< MatchmakeSession > *lstMatchmakeSession)
 マッチメイクセッションをIDで検索します [詳解]
 
qBool FindMatchmakeSessionByGatheringId (ProtocolCallContext *pContext, GatheringID gid, MatchmakeSession *matchmakeSession)
 マッチメイクセッションをIDで検索します [詳解]
 
qBool FindMatchmakeSessionByGatheringIdDetail (ProtocolCallContext *pContext, GatheringID gid, MatchmakeSession *matchmakingSession)
 マッチメイクセッションの詳細情報を取得します。 [詳解]
 
qBool FindMatchmakeSessionByOwner (ProtocolCallContext *pContext, PrincipalID pidOwner, const ResultRange &resultRange, qList< MatchmakeSession > *lstMatchmakeSession)
 マッチメイクセッションをオーナーの PrincipalId で検索します。 [詳解]
 
qBool FindMatchmakeSessionByParticipant (ProtocolCallContext *pContext, const FindMatchmakeSessionByParticipantParam &param, qList< FindMatchmakeSessionByParticipantResult > *pFindResultList)
 指定したユーザーが参加しているマッチメイクセッションのリストを取得します。 [詳解]
 
qBool FindOfficialPersistentGathering (ProtocolCallContext *pContext, qBool isAvailableOnly, const ResultRange &resultRange, qList< PersistentGathering > *pPersistentGatheringList)
 公式永続ギャザリングを検索します [詳解]
 
qBool FindPersistentGatheringByGatheringId (ProtocolCallContext *pContext, const qList< GatheringID > &gatheringIdList, qList< PersistentGathering > *pPersistentGatheringList)
 永続ギャザリングをギャザリングIDで検索します [詳解]
 
qBool FindPersistentGatheringByOwner (ProtocolCallContext *pContext, PrincipalID pidOwner, const ResultRange &resultRange, qList< PersistentGathering > *pPersistentGatheringList)
 永続ギャザリングをオーナーの PrincipalId で検索します。 [詳解]
 
qBool FindPersistentGatheringByParticipant (ProtocolCallContext *pContext, PrincipalID principalId, const ResultRange &resultRange, qList< PersistentGathering > *pPersistentGatheringList)
 永続ギャザリングを参加者のPrincipalIdで検索します [詳解]
 
qBool GenerateMatchmakeSessionSystemPassword (ProtocolCallContext *pContext, GatheringID gatheringId, String *pSystemPassword)
 マッチメイクセッションに、マッチメイクセッションシステムパスワードを設定します。 [詳解]
 
CredentialsGetCredentials () const
 Bind() された Credentials オブジェクトを取得します。 [詳解]
 
qBool GetDetailedParticipants (ProtocolCallContext *pContext, GatheringID id, qList< ParticipantDetails > *pParticipants, qBool bOnlyActive=true)
 ギャザリングの参加者の情報を取得します [詳解]
 
qBool GetFriendNotificationData (ProtocolCallContext *pContext, qList< NotificationEvent > *dataList, qUnsignedInt32 uiType)
 フレンドの通知データをサーバーから取得します。推奨されません。 [詳解]
 
qBool GetFriendNotificationData (ProtocolCallContext *pContext, qList< NotificationEvent > *dataList, const qList< qUnsignedInt32 > &lstTypes)
 フレンドの通知データをサーバーから取得します。推奨されません。 [詳解]
 
qBool GetMyBlackList (ProtocolCallContext *pContext, qList< PrincipalID > *pPrincipalIdList)
 自分がブロックリストに登録しているユーザーのリストを取得します。推奨されません。 [詳解]
 
qBool GetMyBlockList (ProtocolCallContext *pContext, qList< PrincipalID > *pPrincipalIdList)
 自分がブロックリストに登録しているユーザーのリストを取得します。 [詳解]
 
qBool GetParticipantsURLs (ProtocolCallContext *pContext, GatheringID id, qList< StationURL > *plstParticipantsURLs)
 指定したギャザリングの全ての参加者の StationURL を取得します。 [詳解]
 
qBool GetPlayingSession (ProtocolCallContext *pContext, const qList< PrincipalID > &principalIdList, qList< PlayingSession > *pPlayingSessionList)
 指定したユーザーが参加しているマッチメイクセッションのリストを取得します。 [詳解]
 
qBool GetSessionURLs (ProtocolCallContext *pContext, GatheringID gid, qList< StationURL > *lstUrls)
 ギャザリングのホストの StationURL を取得します。 [詳解]
 
qBool JoinMatchmakeSession (ProtocolCallContext *pContext, GatheringID gid, qVector< qByte > *pSessionKey, const String strMessage=NEX_T(""))
 マッチメイクセッションに参加します。推奨されません。 [詳解]
 
qBool JoinMatchmakeSession (ProtocolCallContext *pContext, const JoinMatchmakeSessionParam &joinMatchmakeSessionParam, MatchmakeSession *joinedMatchmakingSession)
 マッチメイクセッションに参加します。 [詳解]
 
qBool JoinPersistentGathering (ProtocolCallContext *pContext, GatheringID gatheringId, const String &strMessage=NEX_T(""), const String &strPassword=NEX_T(""))
 永続ギャザリングに参加します [詳解]
 
qBool MigrateGatheringOwnership (ProtocolCallContext *pContext, GatheringID id, const qList< PrincipalID > &lstPotentialOwnersID)
 ギャザリングのオーナーを別の参加者に変更します。 [詳解]
 
qBool ModifyMatchmakeSessionAttribute (ProtocolCallContext *pContext, GatheringID gid, qUnsignedInt32 attribIndex, qUnsignedInt newValue)
 マッチメイクセッションの属性を変更します。 [詳解]
 
qBool OpenParticipation (ProtocolCallContext *pContext, GatheringID gid)
 マッチメイクセッションへの参加を再開します。 [詳解]
 
qBool RemoveFromBlackList (ProtocolCallContext *pContext, const qList< PrincipalID > &principalIdList)
 ブロックリストから特定のユーザーを削除します。推奨されません。 [詳解]
 
qBool RemoveFromBlockList (ProtocolCallContext *pContext, const qList< PrincipalID > &principalIdList)
 ブロックリストから特定のユーザーを削除します。 [詳解]
 
void SetDefaultCredentials (Credentials *pCredentials)
 
virtual qBool Unbind ()
 証明書の登録を解除します。 [詳解]
 
qBool UnregisterGathering (ProtocolCallContext *pContext, GatheringID idGathering)
 ギャザリングをゲームサーバーから削除します。 [詳解]
 
qBool UpdateApplicationBuffer (ProtocolCallContext *pContext, GatheringID gid, qVector< qUnsignedInt8 > applicationBuffer)
 マッチメイクセッションのアプリケーション定義データを変更します。 [詳解]
 
qBool UpdateGatheringOwnership (ProtocolCallContext *pContext, GatheringID id)
 ギャザリングのオーナーを呼び出したユーザーへ変更します。 [詳解]
 
qBool UpdateMatchmakeSession (ProtocolCallContext *pContext, const GatheringHolder &matchmakingSession)
 マッチメイクセッションを更新します。推奨されません。 [詳解]
 
qBool UpdateMatchmakeSession (ProtocolCallContext *pContext, const UpdateMatchmakeSessionParam &updateMatchmakeSessionParam)
 マッチメイクセッションを更新します。 [詳解]
 
qBool UpdateMatchmakeSessionAttribute (ProtocolCallContext *pContext, GatheringID gid, qUnsignedInt32 attributes[nn::nex::NUM_MATCHMAKE_SESSION_ATTRIBUTES])
 マッチメイクセッションの属性を変更します。 [詳解]
 
qBool UpdateNotificationData (ProtocolCallContext *pContext, qUnsignedInt32 uiType, qUnsignedInt64 uiParam1, qUnsignedInt64 uiParam2, String strParam)
 Notificationデータをサーバーに登録(存在する場合は更新)し、フレンドに通知します。推奨されません。 [詳解]
 
qBool UpdatePersistentGathering (ProtocolCallContext *pContext, const PersistentGathering &persistentGathering)
 永続ギャザリングを更新します。 [詳解]
 
qBool UpdateProgressScore (ProtocolCallContext *pContext, GatheringID gid, qUnsignedInt8 progressScore)
 マッチメイクセッションのゲーム進行度を更新します。 [詳解]
 
qBool UpdateProgressScore (GatheringID gid, qUnsignedInt8 progressScore)
 マッチメイクセッションのゲーム進行度を更新します。 [詳解]
 
qBool UpdateSessionHost (ProtocolCallContext *pContext, GatheringID gid, qBool isMigrateOwner=false)
 ギャザリングのホストを変更します。 [詳解]
 

静的公開メンバ関数

static void ClearPersistentGatheringCodeKey ()
 永続ギャザリングコードのHMAC鍵をクリアします。 [詳解]
 
static qUnsignedInt64 GatheringIdToPersistentGatheringCode (GatheringID gatheringId)
 ギャザリングID から表示用の永続ギャザリングコードを生成します [詳解]
 
static qBool IsValidPersistentGatheringCode (qUnsignedInt64 persistentGatheringCode)
 永続ギャザリングコードが妥当であるかを判定します。 [詳解]
 
static GatheringID PersistentGatheringCodeToGatheringId (qUnsignedInt64 persistentGatheringCode)
 永続ギャザリングコードからギャザリングIDを復元します。 [詳解]
 
static void SetPersistentGatheringCodeKey (const String &strKey)
 永続ギャザリングコードのHMAC鍵を設定します。 [詳解]
 
static qBool StaticUpdateSessionHost (void *pMatchMakingClient, qUnsignedInt32 gatheringID)
 ホストマイグレーション発生時に呼び出されるコールバック向けの関数です。 [詳解]
 
static qBool StaticUpdateSessionHostWithOwner (void *pMatchMakingClient, qUnsignedInt32 gatheringID)
 ホストマイグレーション発生時に呼び出されるコールバック向けの関数です。 [詳解]
 

詳解

マッチメイク機能を利用するためのクラス。

構築子と解体子

nn::nex::MatchmakeExtensionClient::MatchmakeExtensionClient ( )

コンストラクタです。

コンストラクタです。

virtual nn::nex::MatchmakeExtensionClient::~MatchmakeExtensionClient ( )
virtual

デストラクタです。

デストラクタです。

関数詳解

qBool nn::nex::MatchmakeExtensionClient::AutoMatchmake ( ProtocolCallContext pContext,
const AutoMatchmakeParam autoMatchmakeParam,
MatchmakeSession joinedMatchmakingSession 
)

自動的にマッチメイクセッションを検索し、参加します。

指定した AutoMatchmakeParam の内容に応じてマッチメイクセッション(ギャザリング)を検索し、一致するものが見つかればそこに参加します。 見つからなかった場合は新たにマッチメイクセッションを作り、そこに参加、さらに自分がホストになります。

AutoMatchmake() のオーバーロード関数の内本関数のみ複数人のマッチメイクセッションへの参加が行えます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

  • QERROR(Core, InvalidArgument) : 送信しようとした文字列・バッファのサイズ超過。 マッチメイクシステムタイプに MATCHMAKE_SYSTEM_TYPE_PERSISTENT_GATHERING もしくは MATCHMAKE_SYSTEM_TYPE_OLV_COMMUNITY を指定したが、 0 番目の属性もしくは関連付ける永続ギャザリングの ID に永続ギャザリングのギャザリングIDをセットしていない。 オプションビットフラグに AUTO_MATCHMAKE_OPTION_UNIQUE_GATHERING_BY_CODEWORD を指定したとき、あいことばが設定されていないか、 AutoMatchmakeParam::SetSourceMatchmakeSession()AutoMatchmakeParam::SetSearchCriteria() で異なるあいことばを設定した。
  • QERROR(RendezVous, OutOfRatingRange) : MatchmakeSessionSearchCriteria::SetSelectionMethod () で MATCHMAKE_SELECTION_METHOD_BROADEN_RANGE もしくは MATCHMAKE_SELECTION_METHOD_BROADEN_RANGE_WITH_PROGRESS_SCORE を指定したとき、 インデックス MATCHMAKE_SESSION_BROADEN_RANGE_ATTRIBUTE_INDEX の属性値がレンジ外。
  • QERROR(RendezVous, LimitExceeded) : 開発環境で、ギャザリング作成時に自分がオーナーのマッチメイクセッションが 20 個すでに存在していた場合に発生します。 このエラーはあくまでクライアントのバグを検出したりシステムを保護したりするのを目的に、開発環境でのみ発生するものです。 このエラーが返ってくることを前提として作成するマッチメイクセッションの個数を制御したりしないでください。
引数
[in,out]pContext呼び出し情報。
[in]autoMatchmakeParamオートマッチメイク処理に関するパラメータ
[out]joinedMatchmakingSession参加したマッチメイクセッション。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::BrowseMatchmakeSession ( ProtocolCallContext pContext,
const MatchmakeSessionSearchCriteria searchCriteria,
qList< MatchmakeSession > *  lstMatchmakeSession 
)

マッチメイクセッションを検索します。

指定した条件でマッチメイクセッションを検索します。 検索範囲は、 引数 searchCriteria オブジェクトの MatchmakeSessionSearchCriteria::SetResultRange() で指定します。

非同期処理の結果、以下の Result が返ることがあります。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]searchCriteria検索条件。
[out]lstMatchmakeSession見つかったマッチメイクセッション。


戻り値一覧:

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

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

参照
MatchmakeSessionSearchCriteria::SetResultRange()
qBool nn::nex::MatchmakeExtensionClient::BrowseMatchmakeSession ( ProtocolCallContext pContext,
const MatchmakeSessionSearchCriteria searchCriteria,
qList< MatchmakeSession > *  lstMatchmakeSession,
qList< GatheringURLs > *  lstGatheringURLs 
)

マッチメイクセッションを検索します。

指定した条件でマッチメイクセッションを検索し、マッチメイクセッションのホストのURLも併せて取得します。 検索範囲は、 引数 searchCriteria オブジェクトの MatchmakeSessionSearchCriteria::SetResultRange() で指定します。 ホストが決定していないマッチメイクセッションは検索対象から除外されます。

非同期処理の結果、以下の Result が返ることがあります。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]searchCriteria検索条件。
[out]lstMatchmakeSession見つかったマッチメイクセッション。
[out]lstGatheringURLsマッチメイクセッションのホストのURL


戻り値一覧:

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

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

参照
MatchmakeSessionSearchCriteria::SetResultRange()
qBool nn::nex::MatchmakeExtensionClient::BrowseMatchmakeSession ( ProtocolCallContext pContext,
const MatchmakeSessionSearchCriteria searchCriteria,
const ResultRange resultRange,
qList< MatchmakeSession > *  lstMatchmakeSession 
)

マッチメイクセッションを検索します。推奨されません。

非推奨:
MatchmakeSession クラスで結果を取得し、MatchmakeSessionSearchCriteria クラスで検索範囲を指定するオーバーロード関数の使用を推奨します。

指定した条件でマッチメイクセッションを検索します。

非同期処理の結果、以下の Result が返ることがあります。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]searchCriteria検索条件。
[in]resultRange検索範囲。
[out]lstMatchmakeSession見つかったマッチメイクセッション。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::BrowseMatchmakeSession ( ProtocolCallContext pContext,
const MatchmakeSessionSearchCriteria searchCriteria,
const ResultRange resultRange,
qList< MatchmakeSession > *  lstMatchmakeSession,
qList< GatheringURLs > *  lstGatheringURLs 
)

マッチメイクセッションを検索します。推奨されません。

非推奨:
MatchmakeSession クラスで結果を取得し、MatchmakeSessionSearchCriteria クラスで検索範囲を指定するオーバーロード関数の使用を推奨します。

指定した条件でマッチメイクセッションを検索し、マッチメイクセッションのホストのURLも併せて取得します。 ホストが決定していないマッチメイクセッションは検索対象から除外されます。

非同期処理の結果、以下の Result が返ることがあります。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]searchCriteria検索条件。
[in]resultRange検索範囲。
[out]lstMatchmakeSession見つかったマッチメイクセッション。
[out]lstGatheringURLsマッチメイクセッションのホストのURL


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::CreateMatchmakeSession ( ProtocolCallContext pContext,
const CreateMatchmakeSessionParam createMatchmakeSessionParam,
MatchmakeSession joinedMatchmakingSession 
)

マッチメイクセッションを作成し、参加します。

指定したマッチメイクセッションを作成し、参加、さらに自分がオーナー、ホストになります。 非同期処理に成功すると、作成されたマッチメイクセッションの GatheringID と ゲームサーバーで生成された P2P 通信用の共通鍵がセットされます。 共通鍵はマッチメイクセッション参加者に共有されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

  • QERROR(Core, InvalidArgument) : 送信しようとした文字列・バッファのサイズ超過。matchmakingSessionパラメータが不正。 マッチメイクシステムタイプに MATCHMAKE_SYSTEM_TYPE_PERSISTENT_GATHERING もしくは MATCHMAKE_SYSTEM_TYPE_OLV_COMMUNITY を指定したが、 0 番目の属性もしくは関連付ける永続ギャザリングの ID に永続ギャザリングのギャザリングIDをセットしていない。
  • QERROR(RendezVous, LimitExceeded) : 開発環境で、ギャザリング作成時に自分がオーナーのマッチメイクセッションが 20 個すでに存在していた場合に発生します。 このエラーはあくまでクライアントのバグを検出したりシステムを保護したりするのを目的に、開発環境でのみ発生するものです。 このエラーが返ってくることを前提として作成するマッチメイクセッションの個数を制御したりしないでください。
引数
[in,out]pContext呼び出し情報。
[in]createMatchmakeSessionParamマッチメイクセッション作成処理に関するパラメータ。
[out]joinedMatchmakingSession参加したマッチメイクセッション。


戻り値一覧:

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

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

参照
Network::SetP2PDataPacketSessionSignatureKey()
qBool nn::nex::MatchmakeExtensionClient::JoinMatchmakeSession ( ProtocolCallContext pContext,
GatheringID  gid,
qVector< qByte > *  pSessionKey,
const String  strMessage = NEX_T("") 
)

マッチメイクセッションに参加します。推奨されません。

非推奨:
JoinMatchmakeSessionParam を引数に取るオーバーロード関数の使用を推奨します。

指定したIDのマッチメイクセッションに参加します。参加に成功するとマッチメイクセッションのオーナーにイベントが通知されます。 非同期処理に成功すると、 P2P 通信用の共通鍵がセットされます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]gid参加したいマッチメイクセッションのID。
[out]pSessionKeyP2P セッション用の通信鍵。鍵長は Network::MAX_P2P_SIGNATURE_KEY_LEN byte です。
[in]strMessageギャザリングのオーナーもしくは参加者に通知されるメッセージ。最大 MATCHMAKE_STRING_MAX_LENGTH 文字です。


戻り値一覧:

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

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

参照
Network::SetP2PDataPacketSessionSignatureKey()
qBool nn::nex::MatchmakeExtensionClient::JoinMatchmakeSession ( ProtocolCallContext pContext,
const JoinMatchmakeSessionParam joinMatchmakeSessionParam,
MatchmakeSession joinedMatchmakingSession 
)

マッチメイクセッションに参加します。

指定したIDのマッチメイクセッションに参加します。参加に成功するとマッチメイクセッションのオーナーにイベントが通知されます。 非同期処理に成功すると、 P2P 通信用の共通鍵がセットされます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]joinMatchmakeSessionParamマッチメイクセッション参加処理に関するパラメータ。
[out]joinedMatchmakingSession参加したマッチメイクセッション。


戻り値一覧:

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

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

参照
Network::SetP2PDataPacketSessionSignatureKey()
qBool nn::nex::MatchmakeExtensionClient::CloseParticipation ( ProtocolCallContext pContext,
GatheringID  gid 
)

マッチメイクセッションへの参加を締め切ります。

指定したマッチメイクセッションへの参加を締め切ります。マッチメイクセッションのオーナーしか行えません。 タイミングによっては本 RMC 呼び出し成功後も参加される可能性がありますのでご注意ください。

非同期処理に成功すると、MatchmakeExtensionClient::BrowseMatchmakeSession() などで取得できる MatchmakeSession の募集状態フラグ (MatchmakeSession::GetOpenParticipation() で取得可能)もfalseになります。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid参加を締め切るマッチメイクセッションのID。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::OpenParticipation ( ProtocolCallContext pContext,
GatheringID  gid 
)

マッチメイクセッションへの参加を再開します。

指定したマッチメイクセッションへの参加を再開します。マッチメイクセッションのオーナーしか行えません。

非同期処理に成功すると、MatchmakeExtensionClient::BrowseMatchmakeSession() などで取得できる MatchmakeSession の募集状態フラグ (MatchmakeSession::GetOpenParticipation() で取得可能)もtrueになります。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid参加を再開させるマッチメイクセッションのID。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::ModifyMatchmakeSessionAttribute ( ProtocolCallContext pContext,
GatheringID  gid,
qUnsignedInt32  attribIndex,
qUnsignedInt  newValue 
)

マッチメイクセッションの属性を変更します。

指定したマッチメイクセッションの属性を変更します。マッチメイクセッションのオーナーしか行えません。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid属性を変更するマッチメイクセッションのID。
[in]attribIndex変更する属性のインデックス[1-NUM_MATCHMAKE_SESSION_ATTRIBUTES]。
[in]newValue変更後の属性値。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateMatchmakeSessionAttribute ( ProtocolCallContext pContext,
GatheringID  gid,
qUnsignedInt32  attributes[nn::nex::NUM_MATCHMAKE_SESSION_ATTRIBUTES] 
)

マッチメイクセッションの属性を変更します。

指定したマッチメイクセッションの属性を全て変更します。マッチメイクセッションのオーナーしか行えません。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid属性を変更するマッチメイクセッションのID。
[in]attributes変更後の属性値の配列。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateProgressScore ( ProtocolCallContext pContext,
GatheringID  gid,
qUnsignedInt8  progressScore 
)

マッチメイクセッションのゲーム進行度を更新します。

マッチメイクセッションのゲーム進行度を更新します。マッチメイクセッションのオーナーしか行えません。

この関数は、初回呼び出し時以降、 UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME 秒以上の間隔で呼んでください。 UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME 秒より短い間隔で呼ぶと、失敗します。 ただし、ゲーム進行度に 0 または MAX_PROGRESS_SCORE を指定した場合は、 UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME 秒より短い間隔で呼んでも、ゲーム進行度を更新することができます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid属性を変更するマッチメイクセッションのID。
[in]progressScoreゲーム進行度。0 以上 MAX_PROGRESS_SCORE 以下の値を指定できます。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateProgressScore ( GatheringID  gid,
qUnsignedInt8  progressScore 
)

マッチメイクセッションのゲーム進行度を更新します。

マッチメイクセッションのゲーム進行度を更新します。マッチメイクセッションのオーナーしか行えません。

この関数は、初回呼び出し時以降、 UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME 秒以上の間隔で呼んでください。 UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME 秒より短い間隔で呼ぶと、失敗します。 ただし、ゲーム進行度に 0 または MAX_PROGRESS_SCORE を指定した場合は、 UPDATE_PROGRESS_SCORE_MINIMUM_INTERVAL_TIME 秒より短い間隔で呼んでも、ゲーム進行度を更新することができます。

ProtocolCallContext は不要で、内部で処理されます。

引数
[in]gid属性を変更するマッチメイクセッションのID。
[in]progressScoreゲーム進行度。0 以上 MAX_PROGRESS_SCORE 以下の値を指定できます。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateApplicationBuffer ( ProtocolCallContext pContext,
GatheringID  gid,
qVector< qUnsignedInt8 applicationBuffer 
)

マッチメイクセッションのアプリケーション定義データを変更します。

指定したマッチメイクセッションのアプリケーション定義データを変更します。マッチメイクセッションのオーナーしか行えません。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]gid属性を変更するマッチメイクセッションのID。
[in]applicationBufferアプリケーション定義データ。最大 MATCHMAKE_BUFFER_MAX_LENGTH byte までセットできます。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateMatchmakeSession ( ProtocolCallContext pContext,
const GatheringHolder matchmakingSession 
)

マッチメイクセッションを更新します。推奨されません。

非推奨:
UpdateMatchmakeSessionParam を引数に取るオーバーロード関数の使用を推奨します。

マッチメイクセッションの ID、オーナー、 P2P 通信のホスト、ギャザリングフラグ, P2P セッション用の通信鍵, 関連する永続ギャザリングの ID 以外の全てのデータを更新します。 マッチメイクシステムタイプは MATCHMAKE_SYSTEM_TYPE_ANYBODY と MATCHMAKE_SYSTEM_TYPE_FRIEND との間のみ変更できます。 マッチメイクセッションのオーナーしか行えません。 本関数を呼び出す前に、更新対象のマッチメイクセッションにギャザリングID を指定する必要があります。指定は Gathering::SetID() で行います。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]matchmakingSession更新するマッチメイクセッション。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateMatchmakeSession ( ProtocolCallContext pContext,
const UpdateMatchmakeSessionParam updateMatchmakeSessionParam 
)

マッチメイクセッションを更新します。

指定したデータのみを更新します。 マッチメイクセッションのオーナーしか行えません。 本関数を呼び出す前に、更新対象のマッチメイクセッションにギャザリングID を指定する必要があります。指定は Gathering::SetID() で行います。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]updateMatchmakeSessionParamマッチメイクセッション更新処理に関するパラメータ。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdateNotificationData ( ProtocolCallContext pContext,
qUnsignedInt32  uiType,
qUnsignedInt64  uiParam1,
qUnsignedInt64  uiParam2,
String  strParam 
)

Notificationデータをサーバーに登録(存在する場合は更新)し、フレンドに通知します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。 プラットフォームごとの SDK に含まれるフレンドプレゼンス API 利用することを推奨します。

Notificationデータが登録してあると、ログアウトしたときフレンドに NotificationEvents::GameNotificationLogout が通知されます。

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

引数
[in,out]pContext呼び出し情報。
[in]uiType通知のタイプ
[in]uiParam1通知データ1
[in]uiParam2通知データ2
[in]strParam通知データ(最大 MATCHMAKE_STRING_MAX_LENGTH 文字の文字列)


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::GetFriendNotificationData ( ProtocolCallContext pContext,
qList< NotificationEvent > *  dataList,
qUnsignedInt32  uiType 
)

フレンドの通知データをサーバーから取得します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。 プラットフォームごとの SDK に含まれるフレンドプレゼンス API 利用することを推奨します。
引数
[in,out]pContext呼び出し情報。
[out]dataList通知リスト
[in]uiType要求する通知のタイプ (NotificationEvents::GameNotificationType1NotificationEvents::GameNotificationType8 の範囲内である必要があります)


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::GetFriendNotificationData ( ProtocolCallContext pContext,
qList< NotificationEvent > *  dataList,
const qList< qUnsignedInt32 > &  lstTypes 
)

フレンドの通知データをサーバーから取得します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。 プラットフォームごとの SDK に含まれるフレンドプレゼンス API 利用することを推奨します。
引数
[in,out]pContext呼び出し情報。
[out]dataList通知リスト
[in]lstTypes要求する通知のタイプリスト (NotificationEvents::GameNotificationType1NotificationEvents::GameNotificationType8 の範囲内である必要があります)


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::GetPlayingSession ( ProtocolCallContext pContext,
const qList< PrincipalID > &  principalIdList,
qList< PlayingSession > *  pPlayingSessionList 
)

指定したユーザーが参加しているマッチメイクセッションのリストを取得します。

フレンド以外であっても参加中のセッション情報が取得可能ですが、検索対象ユーザーが自分をブロックリストに登録している場合は検索結果に含まれることはありません。

指定した相手が複数のマッチメイクセッションに参加している場合は、複数のセッション情報が取得できます。最大 MAX_MATCHMAKE_SESSION_BY_PARTICIPANT 件返ります。

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

引数
[in,out]pContext呼び出し情報
[in]principalIdList参加者のID
[out]pPlayingSessionList参加していているマッチメイクセッションのリスト


戻り値一覧:

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

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

非推奨:
MachmakeExtensionClient::FindMatchmakeSessionByParticipant を使用してください
qBool nn::nex::MatchmakeExtensionClient::FindMatchmakeSessionByParticipant ( ProtocolCallContext pContext,
const FindMatchmakeSessionByParticipantParam param,
qList< FindMatchmakeSessionByParticipantResult > *  pFindResultList 
)

指定したユーザーが参加しているマッチメイクセッションのリストを取得します。

param で指定された検索パラメータによってブロックリストの有無や、取得できるマッチメイクセッション情報が変わります

指定した相手が複数のマッチメイクセッションに参加している場合は、複数のセッション情報が取得できます。 最大 MAX_MATCHMAKE_SESSION_BY_PARTICIPANT 件返ります。

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

引数
[in,out]pContext呼び出し情報
[in]param検索パラメータ
[out]pFindResultList参加していているマッチメイクセッションのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail ( ProtocolCallContext pContext,
GatheringID  gid,
MatchmakeSession matchmakingSession 
)

マッチメイクセッションの詳細情報を取得します。

指定したIDのマッチメイクセッションの詳細情報を取得します。情報には P2P 通信用の共通鍵が含まれます。 指定したマッチメイクセッションに参加している必要があります。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid情報を取得したいマッチメイクセッションのID。
[out]matchmakingSession取得したマッチメイクセッション情報。


戻り値一覧:

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

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

参照
Network::SetP2PDataPacketSessionSignatureKey()
qBool nn::nex::MatchmakeExtensionClient::FindMatchmakeSessionByGatheringId ( ProtocolCallContext pContext,
const qList< GatheringID > &  gatheringIdList,
qList< MatchmakeSession > *  lstMatchmakeSession 
)

マッチメイクセッションをIDで検索します

指定したIDのマッチメイクセッションを検索します。 参加していないマッチメイクセッションの情報も取得できますが、取得した情報には P2P 通信用の共通鍵が含まれません。 P2P 通信用の共通鍵を含んだ情報を取得する場合は、 MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail() を使用します。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]gatheringIdListマッチメイクセッションのIDのリスト
[out]lstMatchmakeSession見つかったマッチメイクセッションのリスト、存在しないマッチメイクセッションは含まれません、また取得されるマッチメイクセッションの順番は不定です


戻り値一覧:

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

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

参照
MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail()
qBool nn::nex::MatchmakeExtensionClient::FindMatchmakeSessionByGatheringId ( ProtocolCallContext pContext,
GatheringID  gid,
MatchmakeSession matchmakeSession 
)

マッチメイクセッションをIDで検索します

指定したIDのマッチメイクセッションを検索します。 参加していないマッチメイクセッションの情報も取得できますが、取得した情報には P2P 通信用の共通鍵が含まれません。 P2P 通信用の共通鍵を含んだ情報を取得する場合は、 MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail() を使用します。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]gidマッチメイクセッションのID
[out]matchmakeSession見つかったマッチメイクセッション


戻り値一覧:

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

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

参照
MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail()
qBool nn::nex::MatchmakeExtensionClient::FindMatchmakeSessionByOwner ( ProtocolCallContext pContext,
PrincipalID  pidOwner,
const ResultRange resultRange,
qList< MatchmakeSession > *  lstMatchmakeSession 
)

マッチメイクセッションをオーナーの PrincipalId で検索します。

指定した PrincipalId のユーザーがオーナーとなっている見つかったマッチメイクセッションを検索します。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]pidOwner検索キーとなる PrincipalId
[in]resultRange検索範囲
[out]lstMatchmakeSession見つかったマッチメイクセッション


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::AddToBlackList ( ProtocolCallContext pContext,
const qList< PrincipalID > &  principalIdList 
)

ブロックリストにユーザーを追加します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::AddToBlockList() を使用して下さい。

すでにフレンド関係が成立している場合は登録できません。 すでにブロックリストに追加されているユーザーは無視されます。

ブロックリスト登録後にフレンド関係が成立しても、自動的にブロックリストから削除されることはありません。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[out]principalIdList追加するユーザーのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::AddToBlockList ( ProtocolCallContext pContext,
const qList< PrincipalID > &  principalIdList 
)

ブロックリストにユーザーを追加します。

すでにフレンド関係が成立している場合は登録できません。 すでにブロックリストに追加されているユーザーは無視されます。

ブロックリスト登録後にフレンド関係が成立しても、自動的にブロックリストから削除されることはありません。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[out]principalIdList追加するユーザーのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::RemoveFromBlackList ( ProtocolCallContext pContext,
const qList< PrincipalID > &  principalIdList 
)

ブロックリストから特定のユーザーを削除します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::RemoveFromBlockList() を使用して下さい。
引数
[in,out]pContext呼び出し情報
[out]principalIdListPrincipalIdのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::RemoveFromBlockList ( ProtocolCallContext pContext,
const qList< PrincipalID > &  principalIdList 
)

ブロックリストから特定のユーザーを削除します。

引数
[in,out]pContext呼び出し情報
[out]principalIdListPrincipalIdのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::GetMyBlackList ( ProtocolCallContext pContext,
qList< PrincipalID > *  pPrincipalIdList 
)

自分がブロックリストに登録しているユーザーのリストを取得します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::GetMyBlockList() を使用して下さい。
引数
[in,out]pContext呼び出し情報
[out]pPrincipalIdList自分がブロックリストに登録しているユーザーのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::GetMyBlockList ( ProtocolCallContext pContext,
qList< PrincipalID > *  pPrincipalIdList 
)

自分がブロックリストに登録しているユーザーのリストを取得します。

引数
[in,out]pContext呼び出し情報
[out]pPrincipalIdList自分がブロックリストに登録しているユーザーのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::ClearBlackList ( ProtocolCallContext pContext)

自分がサーバーに登録したブロックリストを全て削除します。推奨されません。

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::ClearBlockList() を使用して下さい。
引数
[in,out]pContext呼び出し情報


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::ClearBlockList ( ProtocolCallContext pContext)

自分がサーバーに登録したブロックリストを全て削除します。

引数
[in,out]pContext呼び出し情報


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::CreatePersistentGathering ( ProtocolCallContext pContext,
const PersistentGathering persistentGathering,
GatheringID pGatheringId,
const String strMessage = NEX_T("") 
)

永続ギャザリングを登録します

指定した永続ギャザリングを作成し、参加、さらに自分がオーナーになります。 一人のユーザが作成できる永続ギャザリングの数は、PERSISTENT_GATHERING_CREATION_MAX です。 また、作成した永続ギャザリングに自動的に参加するため、参加している永続ギャザリングの数が、 PERSISTENT_GATHERING_PARTICIPATION_MAX 未満である必要があります。

公式永続ギャザリングは、作成時にオーナーのプリンシパル ID が、特別なプリンシパル ID(101) となり、 作成したクライアント から、削除・更新ができなくなります。 NMAS からの操作で、削除・更新を行ってください。

永続ギャザリングは参加者が 0 になる、または永続ギャザリングのオーナーが明示的に MatchMakingClient::UnregisterGathering() によって削除しない限り、永続的にゲームサーバに残り続けます。

引数
[in,out]pContext呼び出し情報。
[in]persistentGathering登録する永続ギャザリング
[out]pGatheringId登録成功時にサーバが発行する永続ギャザリングのID
[in]strMessage参加者が固有に登録できるメッセージ。最大 MATCHMAKE_STRING_MAX_LENGTH 文字です。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::UpdatePersistentGathering ( ProtocolCallContext pContext,
const PersistentGathering persistentGathering 
)

永続ギャザリングを更新します。

永続ギャザリングを更新します。永続ギャザリングの Id, Owner, PersistentGatheringType 以外の全てのデータを更新します。 永続ギャザリングのオーナーしか行えません。 公式永続ギャザリングの場合は、更新に失敗します。

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

引数
[in,out]pContext呼び出し情報
[in]persistentGathering変更する永続ギャザリング情報


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::JoinPersistentGathering ( ProtocolCallContext pContext,
GatheringID  gatheringId,
const String strMessage = NEX_T(""),
const String strPassword = NEX_T("") 
)

永続ギャザリングに参加します

指定したIDの永続ギャザリングに参加します。 一人のユーザーが参加できる永続ギャザリングの数は、PERSISTENT_GATHERING_PARTICIPATION_MAX です。 MatchMakingClient::EndParticipation() で明示的に退出しない限り永続ギャザリングへの参加状態は残り続けます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

以下は エラー・EULAアプレットにエラーを渡してください。デバッグ時に取り除かれるべきエラーです。

引数
[in,out]pContext呼び出し情報。
[in]gatheringId参加する永続ギャザリングのID
[in]strMessage参加者が固有に登録できるメッセージ。最大 MATCHMAKE_STRING_MAX_LENGTH 文字です。
[in]strPassword永続ギャザリングのパスワード。永続ギャザリングがPasswordLockの場合のみ有効


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::FindPersistentGatheringByGatheringId ( ProtocolCallContext pContext,
const qList< GatheringID > &  gatheringIdList,
qList< PersistentGathering > *  pPersistentGatheringList 
)

永続ギャザリングをギャザリングIDで検索します

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

引数
[in,out]pContext呼び出し情報
[in]gatheringIdList永続ギャザリングのギャザリングIDのリスト
[out]pPersistentGatheringList検索でみつかった永続ギャザリングのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::FindOfficialPersistentGathering ( ProtocolCallContext pContext,
qBool  isAvailableOnly,
const ResultRange resultRange,
qList< PersistentGathering > *  pPersistentGatheringList 
)

公式永続ギャザリングを検索します

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

引数
[in,out]pContext呼び出し情報
[out]pPersistentGatheringList検索でみつかった永続ギャザリングのリスト
[in]isAvailableOnly参加可能な永続ギャザリングのみ検索対象に含めるかどうか
[in]resultRange検索範囲


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::FindPersistentGatheringByParticipant ( ProtocolCallContext pContext,
PrincipalID  principalId,
const ResultRange resultRange,
qList< PersistentGathering > *  pPersistentGatheringList 
)

永続ギャザリングを参加者のPrincipalIdで検索します

PrincipalIDで指定されるユーザが参加している永続ギャザリングのリストを取得します。

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

フレンド以外であっても永続ギャザリングの参加状態が取得可能ですが、検索対象ユーザが自分をブロックリストに登録している場合は検索結果に含まれることはありません。

引数
[in,out]pContext呼び出し情報
[out]pPersistentGatheringList検索でみつかった永続ギャザリングのリスト
[in]principalId参加者のPrincipalId
[in]resultRange検索範囲


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::FindPersistentGatheringByOwner ( ProtocolCallContext pContext,
PrincipalID  pidOwner,
const ResultRange resultRange,
qList< PersistentGathering > *  pPersistentGatheringList 
)

永続ギャザリングをオーナーの PrincipalId で検索します。

指定した PrincipalId のユーザーがオーナーとなっている見つかった永続ギャザリングを検索します。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[out]pPersistentGatheringList検索でみつかった永続ギャザリングのリスト
[in]pidOwner検索キーとなる PrincipalId
[in]resultRange検索範囲


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::GenerateMatchmakeSessionSystemPassword ( ProtocolCallContext pContext,
GatheringID  gatheringId,
String pSystemPassword 
)

マッチメイクセッションに、マッチメイクセッションシステムパスワードを設定します。

サーバ側で SYSTEM_PASSWORD_LENGTH 文字のパスワードを生成し、引数で与えたマッチメイクセッションに設定します。 設定されたパスワードはマッチメイクセッションの参加者全員に、 NotificationEvents::MatchmakeSessionSystemPasswordSet で通知されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]gatheringId生成対象のギャザリングID
[out]pSystemPassword生成されたマッチメイクシステムパスワード


戻り値一覧:

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

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

qBool nn::nex::MatchmakeExtensionClient::ClearMatchmakeSessionSystemPassword ( ProtocolCallContext pContext,
GatheringID  gatheringId 
)

マッチメイクセッションに設定されたマッチメイクセッションシステムパスワードを解除します。

マッチメイクセッションに設定されたマッチメイクセッションシステムパスワードを解除します。 解除した事はマッチメイクセッションの参加者全員に、 NotificationEvents::MatchmakeSessionSystemPasswordClear で通知されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]gatheringId解除対象のギャザリングID


戻り値一覧:

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

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

static qUnsignedInt64 nn::nex::MatchmakeExtensionClient::GatheringIdToPersistentGatheringCode ( GatheringID  gatheringId)
static

ギャザリングID から表示用の永続ギャザリングコードを生成します

永続ギャザリングコードはギャザリングIDとタイトル固有のHMACチェックサム値(14bit)から成り、 10 進 14 桁の正の整数となります(最大 0x3FFFFFFFFFFF まで)。

ギャザリングIDが INVALID_GATHERINGID、または SetPersistentGatheringCodeKey() で鍵が設定されていない場合、INVALID_PERSISTENT_GATHERING_CODE を返します。

本関数を使用する前に SetPersistentGatheringCodeKey() にて永続ギャザリングコードのHMAC鍵を設定する必要があります。 Bind() を行っていなくても実行可能です。

引数
[in]gatheringIdギャザリングID
戻り値
永続ギャザリングコード
static GatheringID nn::nex::MatchmakeExtensionClient::PersistentGatheringCodeToGatheringId ( qUnsignedInt64  persistentGatheringCode)
static

永続ギャザリングコードからギャザリングIDを復元します。

永続ギャザリングコードが INVALID_PERSISTENT_GATHERING_CODE、鍵が一致していない、または SetPersistentGatheringCodeKey() で鍵が設定されていない場合、 INVALID_GATHERINGID を返します。

本関数を使用する前に SetPersistentGatheringCodeKey() にて永続ギャザリングコードのHMAC鍵を設定する必要があります。 Bind() を行っていなくても実行可能です。

引数
[in]persistentGatheringCode永続ギャザリングコード
戻り値
ギャザリングID
static qBool nn::nex::MatchmakeExtensionClient::IsValidPersistentGatheringCode ( qUnsignedInt64  persistentGatheringCode)
static

永続ギャザリングコードが妥当であるかを判定します。

本関数を使用する前に SetPersistentGatheringCodeKey() にて永続ギャザリングコードのHMAC鍵を設定する必要があります。 Bind() を行っていなくても実行可能です。

引数
[in]persistentGatheringCode永続ギャザリングコード
戻り値
妥当な永続ギャザリングコードであるかどうか
static void nn::nex::MatchmakeExtensionClient::SetPersistentGatheringCodeKey ( const String strKey)
static

永続ギャザリングコードのHMAC鍵を設定します。

引数
[in]strKey永続ギャザリングコードのHMAC鍵。自タイトルのアクセスキーを指定してください。
static void nn::nex::MatchmakeExtensionClient::ClearPersistentGatheringCodeKey ( )
static

永続ギャザリングコードのHMAC鍵をクリアします。

SetPersistentGatheringCodeKey() で永続ギャザリングコードのHMAC鍵を設定した場合、ライブラリ終了時には必ず本関数を呼び出してください。

qBool nn::nex::MatchmakeExtensionClient::DebugNotifyEvent ( ProtocolCallContext pContext,
PrincipalID  pid,
qUnsignedInt32  type,
qUnsignedInt32  subType,
qUnsignedInt64  param1,
qUnsignedInt64  param2,
const String stringParam 
)

指定PIDに任意のイベントを送ります。デバッグ用機能です。製品では使用しないでください。

引数
[in,out]pContext呼び出し情報
[in]pid通知先PID
[in]typeNotificationEvent::GetType()で受け取る値
[in]subTypeNotificationEvent::GetSubType()で受け取る値
[in]param1NotificationEvent::GetParam1()で受け取る値
[in]param2NotificationEvent::GetParam2()で受け取る値
[in]stringParamNotificationEvent::GetStringParam()で受け取る値


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::UnregisterGathering ( ProtocolCallContext pContext,
GatheringID  idGathering 
)
inherited

ギャザリングをゲームサーバーから削除します。

指定した ID のギャザリングをゲームサーバーから削除します。ギャザリングのオーナーのみ実行可能です。 非同期処理が成功すると、ギャザリングの参加者全員に NotificationEvents::GatheringUnregistered イベントが通知されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]idGathering削除したいギャザリングの ID


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::FindByID ( ProtocolCallContext pContext,
const qList< GatheringID > &  lstID,
qList< GatheringHolder > *  plstGatherings 
)
inherited

ギャザリングをIDで検索します

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::FindMatchmakeSessionByGatheringId()もしくはMatchmakeExtensionClient::FindPersistentGatheringByGatheringId()を利用して下さい。

指定したIDのギャザリングを検索します。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]lstIDギャザリングのIDのリスト
[out]plstGatherings見つかったギャザリングのリスト


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::FindByID ( ProtocolCallContext pContext,
GatheringID  id,
GatheringHolder pGathering 
)
inherited

ギャザリングをIDで検索します

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::FindMatchmakeSessionByGatheringId()もしくはMatchmakeExtensionClient::FindPersistentGatheringByGatheringId()を利用して下さい。

指定したIDのギャザリングを検索します。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報
[in]idギャザリングのID
[out]pGathering見つかったギャザリング


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::FindByOwner ( ProtocolCallContext pContext,
PrincipalID  pidOwner,
const ResultRange resultRange,
qList< GatheringHolder > *  plstGatherings 
)
inherited

ギャザリングのオーナーの PrincipalId で検索します。

非推奨:
これは互換性のために残されている古い関数です。MatchmakeExtensionClient::FindMatchmakeSessionByOwner()もしくはMatchmakeExtensionClient::FindPersistentGatheringByOwner()を利用して下さい。

指定した PrincipalId のユーザーがオーナーとなっているギャザリングを検索します。

取得したギャザリングが PersistentGathering か判断する場合には Gathering::IsA() に "PersistentGathering" を指定して判断してください。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]pidOwner検索キーとなる PrincipalId
[in]resultRange検索範囲
[out]plstGatherings見つかったギャザリング


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::EndParticipation ( ProtocolCallContext pContext,
GatheringID  id,
const String strMessage = NEX_T("") 
)
inherited

ギャザリング(マッチメイクセッション)から退出します。

指定したIDのギャザリングから退出します。ギャザリングの参加者が 0 人になる場合、自動的にギャザリングが削除されます。

引数
[in,out]pContext呼び出し情報。
[in]id退出するギャザリングのID。
[in]strMessageギャザリングのオーナーもしくは参加者に通知されるメッセージ。最大 MATCHMAKE_STRING_MAX_LENGTH 文字。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::GetParticipantsURLs ( ProtocolCallContext pContext,
GatheringID  id,
qList< StationURL > *  plstParticipantsURLs 
)
inherited

指定したギャザリングの全ての参加者の StationURL を取得します。

本関数で取得した StationURL のリストは VSocket::ProbeStations() に渡すことを想定しています。 StationURL は参加者一人につき複数存在する事があります。 StationURL は対象のギャザリングに参加した順に格納されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]id取得するギャザリングの ID。
[out]plstParticipantsURLs全ての参加者の StationURL のリストが格納されます。
戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::GetDetailedParticipants ( ProtocolCallContext pContext,
GatheringID  id,
qList< ParticipantDetails > *  pParticipants,
qBool  bOnlyActive = true 
)
inherited

ギャザリングの参加者の情報を取得します

指定したIDのギャザリング参加者の情報を取得します。本関数で取得できる ParticipantDetails には、参加者の プリンシパル ID , 参加者の プリンシパル ID を文字列化したもの、MatchmakeExtensionClient::CreateMatchmakeSession() , MatchmakeExtensionClient::JoinMatchmakeSession() , MatchmakeExtensionClient::AutoMatchmake() , EndParticipation() で与えられた文字列がセットされます。

最大参加人数が 無制限(0) または 128 人を超えるギャザリングについては本関数は適用できません。

  • QERROR(Core, InvalidArgument) : 最大参加人数が 無制限(0) または 128 人を超えるギャザリングを指定した。id に INVALID_GATHERINGID を指定した。
引数
[in,out]pContext呼び出し情報
[in]id詳細情報を取得するギャザリングのID
[out]pParticipants参加者の詳細情報
[in]bOnlyActive現時点で参加しているユーザー情報のみを取得するかどうか


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::MigrateGatheringOwnership ( ProtocolCallContext pContext,
GatheringID  id,
const qList< PrincipalID > &  lstPotentialOwnersID 
)
inherited

ギャザリングのオーナーを別の参加者に変更します。

指定したギャザリングのオーナーを別の参加者に変更します。ギャザリングのオーナーしか行えません。 オーナーの変更に成功すると、ギャザリングの参加者全員に NotificationEvents::OwnershipChangeEvent が通知されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]idオーナーを変更するギャザリングのID。
[in]lstPotentialOwnersIDオーナーを移譲する候補リスト。リストが空の場合、自動的にギャザリングの参加者の中から選ばれます。


戻り値一覧:

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

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

qBool nn::nex::MatchMakingClient::UpdateGatheringOwnership ( ProtocolCallContext pContext,
GatheringID  id 
)
inherited

ギャザリングのオーナーを呼び出したユーザーへ変更します。

指定したギャザリングのオーナーを呼び出したユーザーへ変更します。 Gathering の flags の GatheringFlags::ChangeOwnerByOtherHost が設定されている必要があります。 オーナーの変更に成功すると、ギャザリングの参加者全員に NotificationEvents::OwnershipChangeEvent が通知されます。 本関数を呼び出したユーザーがすでにオーナーである場合は特に何も行われません。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]idオーナーを変更するギャザリングのID。


戻り値一覧:

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

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

参照
GatheringFlags
qBool nn::nex::MatchMakingClient::UpdateSessionHost ( ProtocolCallContext pContext,
GatheringID  gid,
qBool  isMigrateOwner = false 
)
inherited

ギャザリングのホストを変更します。

指定したギャザリングのホストを、関数を呼び出したユーザーに変更します。 ギャザリングの参加者のみ呼び出し可能です。 オプションにより、Gathering の flags で、 GatheringFlags::ChangeOwnerByOtherHost が設定されている場合に、オーナーを同時に変更可能です。 オーナーが変更された場合はギャザリングの参加者全員に NotificationEvents::OwnershipChangeEvent が通知されます。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

覚え書き
ホストマイグレーション拡張機能を利用すると、P2P の ホストの変更を検知し、自動的に新しいホストがゲームサーバーに通知します。
引数
[in,out]pContext呼び出し情報。
[in]gid変更するギャザリングの ID
[in]isMigrateOwnerギャザリングのオーナーも同時に関数を呼び出したユーザーに変更するか指定します


戻り値一覧:

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

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

参照
HostMigrationExtension
GatheringFlags
static qBool nn::nex::MatchMakingClient::StaticUpdateSessionHost ( void *  pMatchMakingClient,
qUnsignedInt32  gatheringID 
)
staticinherited

ホストマイグレーション発生時に呼び出されるコールバック向けの関数です。

ホストマイグレーション拡張使用時に P2P セッションの親になったときに呼び出されるコールバック向けの関数です。 関数の内部で UpdateSessionHost() を自動的に呼び出し、ゲームサーバーにホストの変更を通知します。

HostMigrationCallback のコンストラクタに渡してください。

引数
[in]pMatchMakingClientMatchMakingClientClient のポインタ
[in]gatheringID変更するギャザリングの ID


戻り値一覧:

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

false 指定した pMatchMakingClient が NULL。

参照
HostMigrationExtension MatchMakingClient::StaticUpdateSessionHostWithOwner()
static qBool nn::nex::MatchMakingClient::StaticUpdateSessionHostWithOwner ( void *  pMatchMakingClient,
qUnsignedInt32  gatheringID 
)
staticinherited

ホストマイグレーション発生時に呼び出されるコールバック向けの関数です。

ホストマイグレーション拡張使用時に P2P セッションの親になったときに呼び出されるコールバック向けの関数です。 関数の内部で UpdateSessionHost() を自動的に呼び出し、ゲームサーバーにホストの変更を通知します。 同時にギャザリングのオーナーを自分自身に変更します。 対象のギャザリングの flags で、 GatheringFlags::ChangeOwnerByOtherHost が設定されている必要があります。

HostMigrationCallback のコンストラクタに渡してください

引数
[in]pMatchMakingClientMatchMakingClientClient のポインタ
[in]gatheringID変更するギャザリングの ID


戻り値一覧:

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

false 指定した pMatchMakingClient が NULL。

参照
HostMigrationExtension MatchMakingClient::StaticUpdateSessionHost()
qBool nn::nex::MatchMakingClient::GetSessionURLs ( ProtocolCallContext pContext,
GatheringID  gid,
qList< StationURL > *  lstUrls 
)
inherited

ギャザリングのホストの StationURL を取得します。

ギャザリングのホストの StationURL を取得します。 ギャザリングの参加者のみ呼び出し可能です。 本関数で取得したURLリストは、加工せずにそのまま Session::JoinSession()VSocket::ProbeStations() に渡すようにしてください。

非同期処理の結果、以下の Result が返ることがあります。これらはアプリケーション側でハンドリングしてください。

引数
[in,out]pContext呼び出し情報。
[in]gid取得するギャザリングの ID
[out]lstUrlsホストの URL のリスト
戻り値一覧:

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 を返します。