RakNet: ConsoleServer Class Reference

The main entry point for the server portion of your remote console application support. More...

#include <ConsoleServer.h>

Collaboration diagram for ConsoleServer:

Collaboration graph

[legend]

List of all members.

Public Member Functions
	ConsoleServer ()
	~ConsoleServer ()
void	SetTransportProvider (TransportInterface *transportInterface, unsigned short port)
	Call this with a derivation of TransportInterface so that the console server can send and receive commands.
void	AddCommandParser (CommandParserInterface *commandParserInterface)
	Add an implementation of CommandParserInterface to the list of command parsers.
void	RemoveCommandParser (CommandParserInterface *commandParserInterface)
	Remove an implementation of CommandParserInterface previously added with AddCommandParser().
void	Update (void)
	Call update to read packet sent from your TransportInterface. You should do this fairly frequently.
void	SetPrompt (const char *_prompt)
	Sets a prompt to show when waiting for user input.
Protected Member Functions
void	ListParsers (SystemAddress systemAddress)
void	ShowPrompt (SystemAddress systemAddress)
Protected Attributes
TransportInterface *	transport
DataStructures::List < CommandParserInterface * >	commandParserList
char *	password [256]
char *	prompt

Detailed Description

The main entry point for the server portion of your remote console application support.

ConsoleServer takes one TransportInterface and one or more CommandParserInterface (s) The TransportInterface will be used to send data between the server and the client. The connecting client must support the protocol used by your derivation of TransportInterface . TelnetTransport and RakNetTransport are two such derivations . When a command is sent by a remote console, it will be processed by your implementations of CommandParserInterface

Definition at line 28 of file ConsoleServer.h.

Constructor & Destructor Documentation

ConsoleServer::ConsoleServer ( )

Definition at line 15 of file ConsoleServer.cpp.

ConsoleServer::~ConsoleServer ( )

Definition at line 21 of file ConsoleServer.cpp.

Member Function Documentation

void ConsoleServer::AddCommandParser ( CommandParserInterface * commandParserInterface )

Add an implementation of CommandParserInterface to the list of command parsers.

Parameters:

[in] commandParserInterface The command parser referred to

Definition at line 47 of file ConsoleServer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ConsoleServer::ListParsers ( SystemAddress systemAddress ) [protected]

Definition at line 280 of file ConsoleServer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ConsoleServer::RemoveCommandParser ( CommandParserInterface * commandParserInterface )

Remove an implementation of CommandParserInterface previously added with AddCommandParser().

Parameters:

[in] commandParserInterface The command parser referred to

Definition at line 71 of file ConsoleServer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ConsoleServer::SetPrompt ( const char * _prompt )

Sets a prompt to show when waiting for user input.

Pass an empty string to clear the prompt Defaults to no prompt

Parameters:

[in] _prompt Null-terminated string of the prompt to use. If you want a newline, be sure to use /r/n

Definition at line 293 of file ConsoleServer.cpp.

void ConsoleServer::SetTransportProvider	(	TransportInterface *	transportInterface,
		unsigned short	port
	)

Call this with a derivation of TransportInterface so that the console server can send and receive commands.

Parameters:

`[in]`	transportInterface	Your interface to use.
`[in]`	port	The port to host on. Telnet uses port 23 by default. RakNet can use whatever you want.

Definition at line 26 of file ConsoleServer.cpp.

Here is the call graph for this function:

void ConsoleServer::ShowPrompt ( SystemAddress systemAddress ) [protected]

Definition at line 289 of file ConsoleServer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void ConsoleServer::Update ( void )

Call update to read packet sent from your TransportInterface. You should do this fairly frequently.

Definition at line 88 of file ConsoleServer.cpp.

Here is the call graph for this function:

Member Data Documentation

DataStructures::List<CommandParserInterface *> ConsoleServer::commandParserList [protected]

Definition at line 61 of file ConsoleServer.h.

char* ConsoleServer::password[256] [protected]

Definition at line 62 of file ConsoleServer.h.

char* ConsoleServer::prompt [protected]

Definition at line 63 of file ConsoleServer.h.

TransportInterface* ConsoleServer::transport [protected]

Definition at line 60 of file ConsoleServer.h.

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