Interface for remote command shell. More...

Inheritance diagram for moost::service::remote_shell_iface:

Public Member Functions
virtual bool	handle_command (std::string &_return, const std::string &cmd, const std::string &args)=0
	Application-specific command handler.
virtual std::string	get_prompt () const =0
	Return application prompt.
virtual std::string	show_help () const =0
	Return command help.

Detailed Description

Interface for remote command shell.

Definition at line 115 of file remote_shell.h.

Member Function Documentation

virtual std::string moost::service::remote_shell_iface::get_prompt ( ) const [pure virtual]

Return application prompt.

virtual bool moost::service::remote_shell_iface::handle_command	(	std::string &	_return,
		const std::string &	cmd,
		const std::string &	args
	)		`[pure virtual]`

Application-specific command handler.

Parameters:

_return	Write any message to be sent back to the user to this variable.
cmd	The command entered by the user
args	Any arguments entered after the command

Returns:: Boolean indicating whether or not the command was known, not whether the command could be handled successfully. Return false if you don't implement any commands.

Here is the caller graph for this function:

virtual std::string moost::service::remote_shell_iface::show_help ( ) const [pure virtual]

Return command help.

Returns:: String containing usage information for the commands provided by the application's command handler. Return an empty string if you don't implement any commands.

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