BackendClient Class Reference

#include <BackendClient.h>

Inheritance diagram for BackendClient:

[legend]

Collaboration diagram for BackendClient:

[legend]

List of all members.

Public Member Functions
bool	Start (const int titleID, const char *encryptionKey)
bool	GetCompleted (void)
BackendServer::Reply	GetReply (void) const
virtual void	CallbackCompleted (void)
virtual bool	CallbackServerAddress (XPAddress &address)
	Returns: Success returns true, failure returns false.
Static Public Member Functions
static void	DisableValidateOrderingCheck (void)
static bool	IsAuthenticated (void)

---

Detailed Description

This backend client can query a backend server to verify the title ID is valid, or can be used to program the rest of the interfaces used by RNLobby.
When using this class to verify a titleID BackendClient::GetReply() must successfully return BackendServer::kReply_ValidTitleID before any other RNLobby client classes are started with their Start() member functions. This is because BackendClient will set the correct server address and encryption key to use for each component service when the component is constructed.

---

Member Function Documentation

bool Start	(	const int	titleID,
		const char *	encryptionKey
	)

Starts a thread to verify the supplied title ID and encryption key. Using title ID 0 (zero) with any encryption key is a special case and will allow locally hosted servers to be used for debugging purposes.

Returns:

Success returns true, failure returns false.

bool GetCompleted

(

void

)

Tests the completion state of the last query. When the query completes the result can be retrieved by using GetReply()

Returns:

A completed query returns true, a pending query returns false.

BackendServer::Reply GetReply

(

void

)

const

Returns the last reply from a completed query.

Returns:

The last reply from a completed query.

static void DisableValidateOrderingCheck

(

void

)

[static]

In debug mode an assert will be generated if BackendClient is used after any other RNLobby service. To disable this check for the cases where LAN mode (without internet verification) is used before connecting to the internet please call this function.

---