PetraServerAdminConsole.TAdminConsole Class Reference

Petra Server Admin Command Line Application More...

Static Public Member Functions
static void	HandleConnectionError (Exception remexp)
	todoComment More...
static bool	ShutDownControlled (bool AWithUserInteraction)
	shut down the server (gets all connected clients to disconnect) More...
static bool	ShutDown (bool AWithUserInteraction)
	shut down the server More...
static void	DisconnectClient (String ConsoleInput)
	disconnect a client More...
static void	Menu ()
	shows the menu and processes the selections of the administrator More...
static void	Start ()
	Connects to the PetraServer and provides a menu with a number of functions, including stopping the PetraServer. More...

Static Public Attributes
const String	ServerAdminPrompt = "SERVERADMIN> "
	the command prompt More...

Detailed Description

Petra Server Admin Command Line Application

Member Function Documentation

DisconnectClient()

static void PetraServerAdminConsole.TAdminConsole.DisconnectClient ( String  ConsoleInput )

inlinestatic

disconnect a client

Parameters

ConsoleInput

HandleConnectionError()

static void PetraServerAdminConsole.TAdminConsole.HandleConnectionError ( Exception  remexp )

inlinestatic

todoComment

Parameters

remexp

Menu()

static void PetraServerAdminConsole.TAdminConsole.Menu ( )

inlinestatic

shows the menu and processes the selections of the administrator

ShutDown()

static bool PetraServerAdminConsole.TAdminConsole.ShutDown ( bool  AWithUserInteraction )

inlinestatic

shut down the server

Parameters

AWithUserInteraction

Returns

true if shutdown was completed

ShutDownControlled()

static bool PetraServerAdminConsole.TAdminConsole.ShutDownControlled ( bool  AWithUserInteraction )

inlinestatic

shut down the server (gets all connected clients to disconnect)

Parameters

AWithUserInteraction

Returns

true if shutdown was completed

Start()

static void PetraServerAdminConsole.TAdminConsole.Start ( )

inlinestatic

Connects to the PetraServer and provides a menu with a number of functions, including stopping the PetraServer.

Returns

void

Member Data Documentation

ServerAdminPrompt

const String PetraServerAdminConsole.TAdminConsole.ServerAdminPrompt = "SERVERADMIN> "

static

the command prompt

---

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

• csharp/ICT/Petra/ServerAdmin/PetraServerAdminConsole/Main.cs