SplitCommand Class Reference

Inheritance diagram for SplitCommand:

Public Member Functions
CmdResult	Handle (User *user, const Params &parameters) CXX11_OVERRIDE
virtual CmdResult	HandleLocal (LocalUser *user, const Params &parameters)
virtual CmdResult	HandleRemote (RemoteUser *user, const Params &parameters)
virtual CmdResult	HandleServer (FakeUser *user, const Params &parameters)
Public Member Functions inherited from Command
	~Command () CXX11_OVERRIDE
void	RegisterService () CXX11_OVERRIDE
virtual void	TellNotEnoughParameters (LocalUser *user, const Params &parameters)
virtual void	TellNotRegistered (LocalUser *user, const Params &parameters)
Public Member Functions inherited from CommandBase
	CommandBase (Module *me, const std::string &cmd, unsigned int minpara=0, unsigned int maxpara=0)
virtual RouteDescriptor	GetRouting (User *user, const CommandBase::Params &parameters)
virtual void	EncodeParameter (std::string &parameter, unsigned int index)
Public Member Functions inherited from ServiceProvider
	ServiceProvider (Module *Creator, const std::string &Name, ServiceType Type)
const char *	GetTypeString () const
void	DisableAutoRegister ()
Public Member Functions inherited from classbase
virtual CullResult	cull ()

Protected Member Functions
	SplitCommand (Module *me, const std::string &cmd, unsigned int minpara=0, unsigned int maxpara=0)
Protected Member Functions inherited from Command
	Command (Module *me, const std::string &cmd, unsigned int minpara=0, unsigned int maxpara=0)

Additional Inherited Members
Public Attributes inherited from Command
unsigned char	flags_needed
bool	force_manual_route
unsigned int	Penalty
unsigned long	use_count
std::string	syntax
bool	works_before_reg
Public Attributes inherited from CommandBase
const unsigned int	min_params
const unsigned int	max_params
bool	allow_empty_last_param
std::vector< TranslateType >	translation
Public Attributes inherited from ServiceProvider
ModuleRef	creator
const std::string	name
const ServiceType	service

Constructor & Destructor Documentation

SplitCommand()

SplitCommand::SplitCommand ( Module *  me, const std::string &  cmd, unsigned int  minpara = 0, unsigned int  maxpara = 0  )

protected

Initializes a new instance of the SplitCommand class.

Parameters

me	The module which created this instance.
cmd	The name of the command.
minpara	The minimum number of parameters that the command accepts.
maxpara	The maximum number of parameters that the command accepts.

Member Function Documentation

Handle()

CmdResult SplitCommand::Handle ( User *  user, const Params &  parameters  )

virtual

Handle the command from a user.

Parameters

user	The user who issued the command.
parameters	The parameters for the command.

Returns

Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID if the command was malformed.

Implements Command.

HandleLocal()

CmdResult SplitCommand::HandleLocal ( LocalUser *  user, const Params &  parameters  )

virtual

Handle the command from a local user.

Parameters

user	The user who issued the command.
parameters	The parameters for the command.

Returns

Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID if the command was malformed.

HandleRemote()

CmdResult SplitCommand::HandleRemote ( RemoteUser *  user, const Params &  parameters  )

virtual

Handle the command from a remote user.

Parameters

user	The user who issued the command.
parameters	The parameters for the command.

Returns

Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID if the command was malformed.

HandleServer()

CmdResult SplitCommand::HandleServer ( FakeUser *  user, const Params &  parameters  )

virtual

Handle the command from a server user.

Parameters

user	The user who issued the command.
parameters	The parameters for the command.

Returns

Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID if the command was malformed.

---

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

• include/ctables.h
• src/commands.cpp