#include <CommandList.h>
|
void | add (Command &command, std::string name="") |
|
void | remove (Command &command) |
|
bool | processRequest (std::string request, TCPSession *session, std::stringstream &data) |
|
int | processCommand (std::string request, TCPSession *session, std::stringstream &data) |
|
Public Member Functions inherited from core::Command |
virtual bool | check (std::string request) |
|
virtual void | output (Session *session) |
|
void | setName (std::string name) |
|
std::string | getName () |
|
|
std::string | name |
|
std::string | tag |
|
CommandList
This object organizes Command objects into a list that is used to parse an input and run the process associated with the selected command.
◆ add()
void core::CommandList::add |
( |
Command & |
command, |
|
|
std::string |
name = "" |
|
) |
| |
Add a new command to the command list and assign a default search value.
◆ processCommand()
int core::CommandList::processCommand |
( |
std::string |
request, |
|
|
TCPSession * |
session, |
|
|
std::stringstream & |
data |
|
) |
| |
|
virtual |
This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object.
- Parameters
-
request | The request that was entered by the user to invoke this command. |
session | Specify the requesting session so that the execution of the command process can return its output to the session. |
- Returns
- Returns 0 if execution of the command was successful. Otherwise returns a non-zero value indicating an error condition.
Reimplemented from core::Command.
The documentation for this class was generated from the following files: