This allows a console client to call most of the functions in RakPeer.

Inheritance diagram for RakNet::RakNetCommandParser:

Public Member Functions
const char *	GetName (void) const
bool	OnCommand (const char command, unsigned numParameters, char parameterList, TransportInterface transport, const SystemAddress &systemAddress, const char *originalString)
	RakNetCommandParser ()
void	SendHelp (TransportInterface *transport, const SystemAddress &systemAddress)
void	SetRakPeerInterface (RakNet::RakPeerInterface *rakPeer)
	~RakNetCommandParser ()
Static Public Member Functions
static void	DestroyInstance (RakNetCommandParser *i)
static RakNetCommandParser *	GetInstance (void)
Protected Attributes
RakPeerInterface *	peer
	Which instance of RakPeer we are working on. Set from SetRakPeerInterface()

Detailed Description

Definition at line 22 of file RakNetCommandParser.h.

Constructor & Destructor Documentation

RakNet::RakNetCommandParser::RakNetCommandParser ( )

RakNet::RakNetCommandParser::~RakNetCommandParser ( )

static void RakNet::RakNetCommandParser::DestroyInstance ( RakNetCommandParser * i ) [static]

static RakNetCommandParser* RakNet::RakNetCommandParser::GetInstance ( void ) [static]

const char* RakNet::RakNetCommandParser::GetName ( void ) const [virtual]

You are responsible for overriding this function and returning a static string, which will identifier your parser. This should return a static string

bool RakNet::RakNetCommandParser::OnCommand	(	const char *	command,
		unsigned	numParameters,
		char **	parameterList,
		TransportInterface *	transport,
		const SystemAddress &	systemAddress,
		const char *	originalString
	)		`[virtual]`

Given command with parameters parameterList , do whatever processing you wish.

Parameters:

[in]	command	The command to process
[in]	numParameters	How many parameters were passed along with the command
[in]	parameterList	The list of parameters. parameterList[0] is the first parameter and so on.
[in]	transport	The transport interface we can use to write to
[in]	systemAddress	The player that sent this command.
[in]	originalString	The string that was actually sent over the network, in case you want to do your own parsing

void RakNet::RakNetCommandParser::SendHelp	(	TransportInterface *	transport,
		const SystemAddress &	systemAddress
	)		`[virtual]`

A callback for when you are expected to send a brief description of your parser to systemAddress

Parameters:

[in]	transport	The transport interface we can use to write to
[in]	systemAddress	The player that requested help.

void RakNet::RakNetCommandParser::SetRakPeerInterface ( RakNet::RakPeerInterface * rakPeer )

Records the instance of RakPeer to perform the desired commands on

Parameters:

[in] rakPeer The RakPeer instance, or a derived class (e.g. RakPeer or RakPeer)

Definition at line 56 of file RakNetCommandParser.h.

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