LobbyStatsResponse Class Reference

Inheritance diagram for LobbyStatsResponse:

Collaboration diagram for LobbyStatsResponse:

Public Member Functions
const Common::JString &	getName (void) const
nByte	getType (void) const
int	getPeerCount (void) const
int	getRoomCount (void) const
virtual Common::JString &	toString (Common::JString &retStr, bool withTypes=false) const
Public Member Functions inherited from Base
virtual	~Base (void)
Public Member Functions inherited from ToString
virtual	~ToString (void)
virtual JString	typeToString (void) const
JString	toString (bool withTypes=false) const

Additional Inherited Members
Static Public Member Functions inherited from Base
static void	setListener (const BaseListener *baseListener)
static int	getDebugOutputLevel (void)
static bool	setDebugOutputLevel (int debugLevel)
static const LogFormatOptions &	getLogFormatOptions (void)
static void	setLogFormatOptions (const LogFormatOptions &options)

Detailed Description

Passed to Listener::onLobbyStatsResponse(), Listener::onLobbyStatsUpdate(). Each instance of this class holds the name, the type and the statistics (peer count and room count) of one specific lobby. Each lobby can be uniquely identified by the combination of its name and type.

See also

Client::opLobbyStats(), Listener::onLobbyStatsResponse(), Listener::onLobbyStatsUpdate(), LobbyStatsRequest

Member Function Documentation

getName()

const JString & getName

(

void

)

const

Returns

the lobby name. Each lobby can be uniquely identified by the combination of its name and type.

getType()

nByte getType

(

void

)

const

Returns

the lobby type. Each lobby can be uniquely identified by the combination of its name and type.

getPeerCount()

int getPeerCount

(

void

)

const

Returns

the number of clients that currently reside in this specific lobby

getRoomCount()

int getRoomCount

(

void

)

const

Returns

the number of clients that currently exist and that belong to this specific lobby.

On room creation the creator of the room can specify the name and type of the lobby to which that room gets assigned in the RoomOptions.

toString()

JString & toString ( Common::JString &  retStr, bool  withTypes = false  ) const

virtual

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

Implements ToString.