|
CmdResult | Handle (User *user, const Params ¶meters) CXX11_OVERRIDE |
|
virtual CmdResult | HandleLocal (LocalUser *user, const Params ¶meters) |
|
virtual CmdResult | HandleRemote (RemoteUser *user, const Params ¶meters) |
|
virtual CmdResult | HandleServer (FakeUser *user, const Params ¶meters) |
|
Public Member Functions inherited from Command |
| ~Command () CXX11_OVERRIDE |
|
void | RegisterService () CXX11_OVERRIDE |
|
virtual void | TellNotEnoughParameters (LocalUser *user, const Params ¶meters) |
|
virtual void | TellNotRegistered (LocalUser *user, const Params ¶meters) |
|
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 ¶meters) |
|
virtual void | EncodeParameter (std::string ¶meter, unsigned int index) |
|
| ServiceProvider (Module *Creator, const std::string &Name, ServiceType Type) |
|
const char * | GetTypeString () const |
|
void | DisableAutoRegister () |
|
virtual CullResult | cull () |
|
|
| 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) |
|
◆ 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. |
◆ 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: