Real command which can be executed. More...
#include <command.hpp>
Public Member Functions | |
| RealCommand (std::string name, TcpReportingInterpreter *parent, unsigned int minargs=0, unsigned int maxargs=0, const char *syntax=0) | |
| virtual bool | correctSyntax (unsigned int argc, std::string *args) |
| Return true if the syntax is correct, false otherwise. More... | |
| const char * | getSyntax () const |
| Return syntax information. | |
| virtual RealCommand * | getRealCommand (const std::vector< Command * > &cmds) const |
| Returns this. | |
| void | execute (int argc, std::string *args) |
| Execute this command. | |
| virtual bool | is (std::string &cmd) const |
| bool | operator== (const std::string &cmp) const |
| Compare on name. | |
| bool | operator!= (const std::string &cmp) const |
| bool | operator< (const Command &cmp) const |
| const std::string & | getName () const |
| Get the name of this command. | |
Static Public Member Functions | |
| static Command * | find (const std::vector< Command * > &cmds, const std::string &cmp) |
| Find the command with the given name in the vector. | |
Protected Member Functions | |
| virtual void | maincode (int argc, std::string *args)=0 |
| Main code to be implemented by children. | |
| bool | sendError102 () const |
| Send the correct syntax to the client. More... | |
| bool | sendOK () const |
| Send the message 101 OK to the client. More... | |
| void | toupper (std::string *args, int index) const |
| Convert the parameter with the given index to upper-case. More... | |
| void | toupper (std::string *args, int start, int stop) const |
| Convert all parameters between the start and stop index to upper-case. More... | |
| Socket & | socket () const |
| Return the socket for this command. More... | |
Protected Attributes | |
| TcpReportingInterpreter * | _parent |
| unsigned int | _minargs |
| unsigned int | _maxargs |
| const char * | _syntax |
| std::string | _name |
Detailed Description
Real command which can be executed.
Definition at line 144 of file command.hpp.
Member Function Documentation
|
virtual |
Return true if the syntax is correct, false otherwise.
Send an error message to the client on incorrect syntax.
Definition at line 487 of file command.cpp.
|
protected |
|
protected |
|
inlineprotected |
Return the socket for this command.
Fast shortcut for _parent->getConnection()->getSocket()
Definition at line 522 of file command.cpp.
|
protected |
Convert the parameter with the given index to upper-case.
The caller has to make sure that the given index is a valid index.
Definition at line 509 of file command.cpp.
|
protected |
Convert all parameters between the start and stop index to upper-case.
The caller has to make sure that both start and stop are valid indexes. stop must be strictly greater than start.
Definition at line 514 of file command.cpp.
The documentation for this class was generated from the following files:
