nn::nex::Gathering Class

Syntax

class Gathering : public nn::nex::RootObject

Description

Represents sessions in which zero or more clients are participating.

The concept of "gathering" is much broader than a "room for matchmaking," but the matchmaking features of the NEX library comprise just the MatchmakeSession class derived from the Gathering class.

Member Functions

GetID Gets the gathering ID.
SetID Sets the gathering ID.
V GetGatheringType Returns the class name of the gathering.
V IsA Determines whether an object has the class name specified by the argument.
V IsAKindOf Determines whether the object is of the class specified by the argument or inherits from that class.
SetDescription Sets a descriptive text string.
GetDescription Gets the descriptive text string.
GetOwnerPID Gets the PrincipalID of the owner of the gathering.
GetHostPID Gets the principal ID of the gathering host.
GetMinParticipants Gets the minimum number of people who can join the gathering.
GetMaxParticipants Gets maximum number of people who can join the gathering.
SetMinParticipants Sets the minimum number of people who can join the gathering.
SetMaxParticipants Sets the maximum number of people who can join the gathering.
FlagIsSet Checks whether the gathering flag has been set.
SetFlag Sets a gathering flag enumerated by GatheringFlags.
ClearFlag Clears the gathering flag.

Class Hierarchy

nn::nex::RootObject
  nn::nex::Gathering

Revision History

2011/01/27
Initial version.

CONFIDENTIAL