LobbyStatsRequest Class Reference

Inheritance diagram for LobbyStatsRequest:

[legend]

Collaboration diagram for LobbyStatsRequest:

[legend]

Public Member Functions
	LobbyStatsRequest (const Common::JString &name=Common::JString(), nByte type=LobbyType::DEFAULT)
const Common::JString &	getName (void) const
nByte	getType (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 Client::opLobbyStats(). Each instance of this class holds the name and the type of a lobby for which the caller of Client::opLobbyStats() wants to request statistics.

See also

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

Constructor & Destructor Documentation

LobbyStatsRequest()

LobbyStatsRequest	(	const Common::JString &	name = Common::JString(),
		nByte	type = LobbyType::DEFAULT
	)

Constructor: Creates a new instance with the specified parameters.

Note

Lobby names are only unique per lobby type and multiple lobbies with the same name, but different type, can exist in parallel. Hence a lobby with the same name but with a different type is treated as a different lobby.

Parameters

name	see setLobbyName() - optional, defaults to an empty JString instance.
type	see setLobbyType() - optional, defaults to LobbyType::DEFAULT. Must be one of the values in LobbyType

Member Function Documentation

getName()

const JString & getName

(

void

)

const

Returns

the lobby name

See also

LobbyStatsRequest()

getType()

nByte getType

(

void

)

const

Returns

the lobby type

See also

LobbyStatsRequest()

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.