epee::command_handler Class Reference

#include <console_handler.h>

Inheritance diagram for epee::command_handler:

Public Types
typedef boost::function< bool(const std::vector< std::string > &)>	callback
typedef boost::function< bool(void)>	empty_callback
typedef std::map< std::string, std::pair< callback, std::pair< std::string, std::string > > >	lookup

Public Member Functions
	command_handler ()
std::string	get_usage ()
std::pair< std::string, std::string >	get_documentation (const std::vector< std::string > &cmd)
std::vector< std::string >	get_command_list (const std::vector< std::string > &keywords=std::vector< std::string >())
void	set_handler (const std::string &cmd, const callback &hndlr, const std::string &usage="", const std::string &description="")
void	set_unknown_command_handler (const callback &hndlr)
void	set_empty_command_handler (const empty_callback &hndlr)
void	set_cancel_handler (const empty_callback &hndlr)
bool	process_command_vec (const std::vector< std::string > &cmd)
bool	process_command_str (const boost::optional< std::string > &cmd)

Private Attributes
lookup	m_command_handlers
callback	m_unknown_command_handler
empty_callback	m_empty_command_handler
empty_callback	m_cancel_handler

Member Typedef Documentation

callback

typedef boost::function<bool (const std::vector<std::string> &)> epee::command_handler::callback

empty_callback

typedef boost::function<bool (void)> epee::command_handler::empty_callback

lookup

typedef std::map<std::string, std::pair<callback, std::pair<std::string, std::string> > > epee::command_handler::lookup

Constructor & Destructor Documentation

command_handler()

epee::command_handler::command_handler ( )

inline

Member Function Documentation

get_command_list()

std::vector< std::string > epee::command_handler::get_command_list ( const std::vector< std::string > & keywords = std::vector<std::string>() )

inline

get_documentation()

std::pair< std::string, std::string > epee::command_handler::get_documentation ( const std::vector< std::string > & cmd )

inline

get_usage()

std::string epee::command_handler::get_usage ( )

inline

process_command_str()

bool epee::command_handler::process_command_str ( const boost::optional< std::string > & cmd )

inline

process_command_vec()

bool epee::command_handler::process_command_vec ( const std::vector< std::string > & cmd )

inline

set_cancel_handler()

void epee::command_handler::set_cancel_handler ( const empty_callback & hndlr )

inline

set_empty_command_handler()

void epee::command_handler::set_empty_command_handler ( const empty_callback & hndlr )

inline

set_handler()

void epee::command_handler::set_handler ( const std::string & cmd, const callback & hndlr, const std::string & usage = "", const std::string & description = "" )

inline

set_unknown_command_handler()

void epee::command_handler::set_unknown_command_handler ( const callback & hndlr )

inline

Member Data Documentation

m_cancel_handler

empty_callback epee::command_handler::m_cancel_handler

private

m_command_handlers

lookup epee::command_handler::m_command_handlers

private

m_empty_command_handler

empty_callback epee::command_handler::m_empty_command_handler

private

m_unknown_command_handler

callback epee::command_handler::m_unknown_command_handler

private

---

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

• contrib/epee/include/console_handler.h