Public Member Functions

RakNetTransportCommandParser Class Reference

RakNetTransport has its own command parser to enable remote users to change the command console's password. More...

#include <RakNetTransport.h>

Inherits CommandParserInterface.

Collaboration diagram for RakNetTransportCommandParser:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 RakNetTransportCommandParser ()
 ~RakNetTransportCommandParser ()
bool OnCommand (const char *command, unsigned numParameters, char **parameterList, TransportInterface *transport, SystemAddress systemAddress, const char *originalString)
const char * GetName (void) const
void SendHelp (TransportInterface *transport, SystemAddress systemAddress)

Detailed Description

RakNetTransport has its own command parser to enable remote users to change the command console's password.

Definition at line 27 of file RakNetTransport.h.


Constructor & Destructor Documentation

RakNetTransportCommandParser::RakNetTransportCommandParser (  ) 

Definition at line 18 of file RakNetTransport.cpp.

Here is the call graph for this function:

RakNetTransportCommandParser::~RakNetTransportCommandParser (  ) 

Definition at line 24 of file RakNetTransport.cpp.


Member Function Documentation

const char * RakNetTransportCommandParser::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

Returns:
The name that you return.

Implements CommandParserInterface.

Definition at line 54 of file RakNetTransport.cpp.

bool RakNetTransportCommandParser::OnCommand ( const char *  command,
unsigned  numParameters,
char **  parameterList,
TransportInterface transport,
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

Implements CommandParserInterface.

Definition at line 27 of file RakNetTransport.cpp.

Here is the call graph for this function:

void RakNetTransportCommandParser::SendHelp ( TransportInterface transport,
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.

Implements CommandParserInterface.

Definition at line 58 of file RakNetTransport.cpp.

Here is the call graph for this function:


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