RakNet::LobbyServer Class Reference

#include <LobbyServer.h>

Inheritance diagram for RakNet::LobbyServer:

PluginInterface RakNet::LobbyServerPostgreSQL

List of all members.

Public Member Functions

void SetOrderingChannel (char oc)
 Ordering channel to use with RakPeer::Send().

Protected Member Functions

void DownloadClans_NetMsg (Packet *packet)
virtual void UpdateClanMember_DBResult (bool dbSuccess, const char *queryErrorMessage, LobbyDBSpec::UpdateClanMember_Data *res, unsigned int lobbyMsgId, SystemAddress systemAddress, LobbyDBSpec::DatabaseKey clanSourceMemberId, RakNet::RakString clanSourceMemberHandle)
virtual void ValidateUserKey_DBResult (bool dbSuccess, const char *queryErrorMessage, TitleValidationDBSpec::ValidateUserKey_Data *res, SystemAddress systemAddress)
virtual void OnAttach (RakPeerInterface *peer)
PluginReceiveResult OnReceive (RakPeerInterface *peer, Packet *packet)
virtual void OnCloseConnection (RakPeerInterface *peer, SystemAddress systemAddress)
virtual void OnShutdown (RakPeerInterface *peer)
virtual void Update (RakPeerInterface *peer)


Detailed Description

Implements the basis for the lobby server for RakNet, independent of any kind of database. Features include user to user interaction, chatting, rooms, and quick match. Just attach as a plugin and go. If you want to interact with the implemented PostgreSQL database, such as adding users or titles, see LobbyServerPostgreSQL

Member Function Documentation

void LobbyServer::DownloadClans_NetMsg ( Packet packet  )  [protected]

Do DB query. Don't just use memory in case it changed from an external source.

void LobbyServer::OnAttach ( RakPeerInterface peer  )  [protected, virtual]

Called when the interface is attached

Parameters:
[in] peer the instance of RakPeer that is calling Receive

Reimplemented from PluginInterface.

void LobbyServer::OnCloseConnection ( RakPeerInterface peer,
SystemAddress  systemAddress 
) [protected, virtual]

Called when a connection is dropped because the user called RakPeer::CloseConnection() for a particular system

Parameters:
[in] peer the instance of RakPeer that is calling Receive
[in] systemAddress The system whose connection was closed

Reimplemented from PluginInterface.

PluginReceiveResult LobbyServer::OnReceive ( RakPeerInterface peer,
Packet packet 
) [protected, virtual]

OnReceive is called for every packet.

Parameters:
[in] peer the instance of RakPeer that is calling Receive
[in] packet the packet that is being returned to the user
Returns:
True to allow the game and other plugins to get this message, false to absorb it

Reimplemented from PluginInterface.

void LobbyServer::OnShutdown ( RakPeerInterface peer  )  [protected, virtual]

Called when RakPeer is shutdown

Parameters:
[in] peer the instance of RakPeer that is calling Receive

Reimplemented from PluginInterface.

void LobbyServer::Update ( RakPeerInterface peer  )  [protected, virtual]

Update is called every time a packet is checked for .

Parameters:
[in] peer - the instance of RakPeer that is calling Receive

Reimplemented from PluginInterface.

Reimplemented in RakNet::LobbyServerPostgreSQL.

void LobbyServer::UpdateClanMember_DBResult ( bool  dbSuccess,
const char *  queryErrorMessage,
LobbyDBSpec::UpdateClanMember_Data *  res,
unsigned int  lobbyMsgId,
SystemAddress  systemAddress,
LobbyDBSpec::DatabaseKey  clanSourceMemberId,
RakNet::RakString  clanSourceMemberHandle 
) [protected, virtual]

This is sent to the new member, and also to all online members of the clan

This is sent to the new member, and also to all online members of the clan

void LobbyServer::ValidateUserKey_DBResult ( bool  dbSuccess,
const char *  queryErrorMessage,
TitleValidationDBSpec::ValidateUserKey_Data *  res,
SystemAddress  systemAddress 
) [protected, virtual]

[out] Validation result. 1 = success. -1 = no keys matched. -2 = key marked as invalid (invalidKeyReason will be filled in), -3 = undefined


The documentation for this class was generated from the following files:

Generated on Tue Feb 10 08:44:09 2009 for RakNet by  doxygen 1.5.7.1