Lobby2::LobbyClientPC Class Reference
[PluginInterface]

PC specific client side code to the lobby system Attach class as a plugin to RakNet as usual. Connect to the lobby server (as usual). Then use provided functions for specific functionality. More...

#include <LobbyClientPC.h>

Inheritance diagram for Lobby2::LobbyClientPC:

PluginInterface Lobby2::LobbyClient List of all members.

Public Member Functions

void SetOrderingChannel (char oc)
 Ordering channel to use with RakPeer::Send().
void SetSendPriority (PacketPriority pp)
 Send priority to use with RakPeer::Send().

Protected Member Functions

void OnAttach (RakPeerInterface *peer)
PluginReceiveResult OnReceive (RakPeerInterface *peer, Packet *packet)
void OnCloseConnection (RakPeerInterface *peer, SystemAddress systemAddress)
void OnShutdown (RakPeerInterface *peer)

Detailed Description

PC specific client side code to the lobby system Attach class as a plugin to RakNet as usual. Connect to the lobby server (as usual). Then use provided functions for specific functionality.

LobbyClient plugin for the PC

Note:
Most function calls are asynchronous so use a callback to get the result. This callback is set with LobbyClientPC::SetCallbackInterface()
See also:
LobbyServer

LobbyServerPostgreSQL


Member Function Documentation

void Lobby2::LobbyClientPC::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.

PluginReceiveResult Lobby2::LobbyClientPC::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 Lobby2::LobbyClientPC::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.

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

Called when RakPeer is shutdown

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

Reimplemented from PluginInterface.


The documentation for this class was generated from the following file:
Generated on Thu Aug 28 19:20:46 2008 for RakNet by  doxygen 1.5.1-p1