epee::console_handlers_binder Class Reference

#include <console_handler.h>

Inheritance diagram for epee::console_handlers_binder:

Collaboration diagram for epee::console_handlers_binder:

Public Member Functions
	~console_handlers_binder ()
bool	start_handling (std::function< std::string(void)> prompt, const std::string &usage_string="", std::function< void(void)> exit_handler=NULL)
bool	start_handling (const std::string &prompt, const std::string &usage_string="", std::function< void(void)> exit_handler=NULL)
void	stop_handling ()
bool	run_handling (std::function< std::string(void)> prompt, const std::string &usage_string, std::function< void(void)> exit_handler=NULL)
void	print_prompt ()
void	cancel_input ()
Public Member Functions inherited from epee::command_handler
	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 Types
typedef command_handler::callback	console_command_handler
typedef command_handler::lookup	command_handlers_map

Private Attributes
std::unique_ptr< boost::thread >	m_console_thread
async_console_handler	m_console_handler

Additional Inherited Members
Public Types inherited from epee::command_handler
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

Member Typedef Documentation

command_handlers_map

typedef command_handler::lookup epee::console_handlers_binder::command_handlers_map

private

console_command_handler

typedef command_handler::callback epee::console_handlers_binder::console_command_handler

private

Constructor & Destructor Documentation

~console_handlers_binder()

epee::console_handlers_binder::~console_handlers_binder ( )

inline

Member Function Documentation

cancel_input()

void epee::console_handlers_binder::cancel_input ( )

inline

print_prompt()

void epee::console_handlers_binder::print_prompt ( )

inline

run_handling()

bool epee::console_handlers_binder::run_handling ( std::function< std::string(void)> prompt, const std::string & usage_string, std::function< void(void)> exit_handler = NULL )

inline

start_handling() [1/2]

bool epee::console_handlers_binder::start_handling ( const std::string & prompt, const std::string & usage_string = "", std::function< void(void)> exit_handler = NULL )

inline

start_handling() [2/2]

bool epee::console_handlers_binder::start_handling ( std::function< std::string(void)> prompt, const std::string & usage_string = "", std::function< void(void)> exit_handler = NULL )

inline

stop_handling()

void epee::console_handlers_binder::stop_handling ( )

inline

Member Data Documentation

m_console_handler

async_console_handler epee::console_handlers_binder::m_console_handler

private

m_console_thread

std::unique_ptr<boost::thread> epee::console_handlers_binder::m_console_thread

private

---

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

• contrib/epee/include/console_handler.h