AdminCmdDataServerQuit Class Reference

Class for terminating the server. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataServerQuit ()
	Creates obj for specified command that ends the server.
	AdminCmdDataServerQuit (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data.
virtual AdminCmdData *	CreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates an object containing the parsed data for server stop.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataServerQuit ()
Public Attributes
csString	reason
	reason for the shutdown
int	time
	time until shutdown

---

Detailed Description

Class for terminating the server.

Definition at line 3049 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataServerQuit::AdminCmdDataServerQuit

(

)

[inline]

Creates obj for specified command that ends the server.

Definition at line 3057 of file adminmanager.h.

AdminCmdDataServerQuit::AdminCmdDataServerQuit	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)

Parses the given message and stores its data.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

virtual AdminCmdDataServerQuit::~AdminCmdDataServerQuit

(

)

[inline, virtual]

Definition at line 3070 of file adminmanager.h.

---

Member Function Documentation

virtual AdminCmdData* AdminCmdDataServerQuit::CreateCmdData	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)		[virtual]

Creates an object containing the parsed data for server stop.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

Returns:

AdminCmdData* pointer to object containing parsed data. When parsing failed the valid flag is set to false.

Reimplemented from AdminCmdData.

virtual csString AdminCmdDataServerQuit::GetHelpMessage

(

)

[virtual]

Returns a helpmessage that fits to the parser of the class.

Returns:

csString: a help message to send back to the client

Reimplemented from AdminCmdData.

---

Member Data Documentation

csString AdminCmdDataServerQuit::reason

reason for the shutdown

Definition at line 3052 of file adminmanager.h.

int AdminCmdDataServerQuit::time

time until shutdown

Definition at line 3053 of file adminmanager.h.

---

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

• server/adminmanager.h