AdminCmdDataKey Class Reference

Class for key (lock) related commands. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataKey ()
	Creates obj for specified command managing locks.
	AdminCmdDataKey (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given lock manage 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.
virtual csString	GetHelpMessage ()
	Returns a helpmessage that fits to the parser of the class.
virtual	~AdminCmdDataKey ()
Public Attributes
csString	subCommand
	subcommand storage
AdminCmdSubCommandParser	subCommandList
	list of sub commands
AdminCmdSubCommandParser	subTargetCommandList
	list of sub commands requiring a target

---

Detailed Description

Class for key (lock) related commands.

Can create/destroy locks, lock/unlock them, create/destroy keys.

Definition at line 1289 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataKey::AdminCmdDataKey

(

)

[inline]

Creates obj for specified command managing locks.

Definition at line 1298 of file adminmanager.h.

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

Parses the given lock manage 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 AdminCmdDataKey::~AdminCmdDataKey

(

)

[inline, virtual]

Definition at line 1313 of file adminmanager.h.

---

Member Function Documentation

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

Creates an object containing the parsed 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

Returns:

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

Reimplemented from AdminCmdDataTarget.

virtual csString AdminCmdDataKey::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 AdminCmdDataTarget.

---

Member Data Documentation

csString AdminCmdDataKey::subCommand

subcommand storage

Definition at line 1294 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataKey::subCommandList

list of sub commands

Definition at line 1292 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdDataKey::subTargetCommandList

list of sub commands requiring a target

Definition at line 1293 of file adminmanager.h.

---

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

• server/adminmanager.h