0人以上のクライアントが参加するセッションをあらわすクラスです。 [詳解]
#include <RendezVous/Services/MatchMaking/src/Common/Gathering.h>
公開メンバ関数 | |
void | ClearFlag (qUnsignedInt32 uiFlag) |
ギャザリングフラグをクリアします [詳解] | |
qBool | FlagIsSet (qUnsignedInt32 uiFlag) const |
ギャザリングフラグがセットされているかを確認します [詳解] | |
const String & | GetDescription () const |
説明文字列を取得します。 [詳解] | |
virtual String | GetGatheringType () const |
自分のクラス名を返します [詳解] | |
PrincipalID | GetHostPID () const |
ギャザリングのホストの プリンシパルID を取得します。 [詳解] | |
GatheringID | GetID () const |
ギャザリングの ID を取得します。 [詳解] | |
qUnsignedInt16 | GetMaxParticipants () const |
ギャザリングの最大参加人数を取得します [詳解] | |
qUnsignedInt16 | GetMinParticipants () const |
ギャザリングの最小参加人数を取得します [詳解] | |
PrincipalID | GetOwnerPID () const |
ギャザリングのオーナーの PrincipalID を取得します。 [詳解] | |
virtual qBool | IsA (const String &strClass) const |
引数で与えられたクラス名のオブジェクトであるかを判定します。 [詳解] | |
virtual qBool | IsAKindOf (const String &strClass) const |
引数で与えられたクラス名のクラスか、それを継承したオブジェクトかを判定します。 [詳解] | |
void | SetDescription (const String &strDescription) |
説明文字列をセットします。 [詳解] | |
void | SetFlag (qUnsignedInt32 uiFlag) |
GatheringFlags で列挙されているギャザリングフラグをセットします [詳解] | |
GatheringID | SetID (GatheringID id) |
ギャザリングの ID を設定します。 [詳解] | |
void | SetMaxParticipants (qUnsignedInt16 uiMaxParticipants) |
ギャザリングの最大参加人数をセットします [詳解] | |
void | SetMinParticipants (qUnsignedInt16 uiMinParticipants) |
ギャザリングの最小参加人数をセットします [詳解] | |
0人以上のクライアントが参加するセッションをあらわすクラスです。
ギャザリングは「マッチメイクの部屋」というよりも広い意味を持つ概念ですが、 NEXライブラリの マッチメイク機能では Gathering クラスを継承した MatchmakeSession クラスのみ 利用可能です。
GatheringID nn::nex::Gathering::GetID | ( | ) | const |
ギャザリングの ID を取得します。
GatheringID nn::nex::Gathering::SetID | ( | GatheringID | id | ) |
ギャザリングの ID を設定します。
MatchmakeExtensionClient::AutoMatchmake() や MatchmakeExtensionClient::CreateMatchmakeSession() などでギャザリングを 登録する際は必ず INVALID_GATHERINGID を指定してください また、 MatchmakeExtensionClient::UpdateMatchmakeSession() を使用する際、 本関数を用いて更新するマッチメイクセッションのギャザリングIDを指定してください。
[in] | id | ギャザリングの ID |
|
virtual |
自分のクラス名を返します
引数で与えられたクラス名のオブジェクトであるかを判定します。
[in] | strClass | クラス名 |
true 引数で与えられたクラス名のクラスオブジェクトである
false 引数で与えられたクラス名のクラスオブジェクトではない
引数で与えられたクラス名のクラスか、それを継承したオブジェクトかを判定します。
[in] | strClass | クラス名 |
true 引数で与えられたクラス名のクラスまたはそれを継承したオブジェクトである
false 引数で与えられたクラス名のクラスまたはそれを継承したオブジェクトではない
void nn::nex::Gathering::SetDescription | ( | const String & | strDescription | ) |
説明文字列をセットします。
ギャザリングの説明文字列をセットします。アプリケーションが任意の値を設定できます(最大 MATCHMAKE_STRING_MAX_LENGTH 文字)。
[in] | strDescription | 説明文字列 |
const String& nn::nex::Gathering::GetDescription | ( | ) | const |
説明文字列を取得します。
ギャザリングの説明文字列を取得します。
PrincipalID nn::nex::Gathering::GetOwnerPID | ( | ) | const |
ギャザリングのオーナーの PrincipalID を取得します。
ギャザリングのオーナーの PrincipalID を取得します。オーナーはギャザリングを変更できる唯一のユーザーで、 マッチメイクの募集状態の変更や、ギャザリングの削除などを行うことができます。
初期状態では、ギャザリングの登録ユーザーがオーナーとなりますが、MatchMakingClient::MigrateGatheringOwnership() を 実行するか、GatheringFlag に MigrateOwner をセットした状態でオーナーが退出することでオーナーを変更することができます。
PrincipalID nn::nex::Gathering::GetHostPID | ( | ) | const |
ギャザリングのホストの プリンシパルID を取得します。
ホストは P2P セッションの管理者で、 ギャザリングの状態を変更したりすることはできません。他のユーザーが P2P セッションに参加する場合、 ホストの URL をサーバーから取得する必要があります。
qUnsignedInt16 nn::nex::Gathering::GetMinParticipants | ( | ) | const |
ギャザリングの最小参加人数を取得します
qUnsignedInt16 nn::nex::Gathering::GetMaxParticipants | ( | ) | const |
ギャザリングの最大参加人数を取得します
void nn::nex::Gathering::SetMinParticipants | ( | qUnsignedInt16 | uiMinParticipants | ) |
ギャザリングの最小参加人数をセットします
ギャザリングの最小参加人数をセットします。現在、本関数でセットした値はマッチメイクに影響を与えません。
[in] | uiMinParticipants | ギャザリングの最小参加人数 |
void nn::nex::Gathering::SetMaxParticipants | ( | qUnsignedInt16 | uiMaxParticipants | ) |
ギャザリングの最大参加人数をセットします
この人数を越えてギャザリングに参加することはできません。 0 を指定した場合は最大参加人数が無制限になります。 MatchmakeExtensionClient::UpdateMatchmakeSession() や MatchmakeExtensionClient::UpdatePersistentGathering() で最大参加人数を更新する場合、 現在の参加人数未満の値を指定する事もできます。この場合は既存の参加者が退出させられることはありませんが、 現在の参加人数が最大参加人数を下回るまでそのギャザリングに参加することはできません。
[in] | uiMaxParticipants | ギャザリングの最大参加人数 |
qBool nn::nex::Gathering::FlagIsSet | ( | qUnsignedInt32 | uiFlag | ) | const |
ギャザリングフラグがセットされているかを確認します
指定されたギャザリングフラグがセットされているかを確認します。
[in] | uiFlag | セットされているかどうか確認するギャザリングフラグ |
void nn::nex::Gathering::SetFlag | ( | qUnsignedInt32 | uiFlag | ) |
void nn::nex::Gathering::ClearFlag | ( | qUnsignedInt32 | uiFlag | ) |