fc::rpc::cli Class Reference

#include <cli.hpp>

Inheritance diagram for fc::rpc::cli:

Collaboration diagram for fc::rpc::cli:

Public Member Functions
	~cli ()
virtual variant	send_call (api_id_type api_id, string method_name, variants args=variants())
virtual variant	send_callback (uint64_t callback_id, variants args=variants())
virtual void	send_notice (uint64_t callback_id, variants args=variants())
void	start ()
void	stop ()
void	wait ()
void	format_result (const string &method, std::function< string(variant, const variants &)> formatter)
virtual void	getline (const fc::string &prompt, fc::string &line)
void	set_prompt (const string &prompt)
Public Member Functions inherited from fc::api_connection
	api_connection ()
virtual	~api_connection ()
template<typename T >
api< T >	get_remote_api (api_id_type api_id=0)
variant	receive_call (api_id_type api_id, const string &method_name, const variants &args=variants()) const
variant	receive_callback (uint64_t callback_id, const variants &args=variants()) const
void	receive_notice (uint64_t callback_id, const variants &args=variants()) const
template<typename Interface >
api_id_type	register_api (const Interface &a)
template<typename Signature >
uint64_t	register_callback (const std::function< Signature > &cb)
std::vector< std::string >	get_method_names (api_id_type local_api_id=0) const

Additional Inherited Members
Public Attributes inherited from fc::api_connection
fc::signal< void()>	closed

Detailed Description

Provides a simple wrapper for RPC calls to a given interface.

Definition at line 16 of file cli.hpp.

Constructor & Destructor Documentation

~cli()

fc::rpc::cli::~cli

(

)

Definition at line 39 of file cli.cpp.

{
   if( _run_complete.valid() )
   {
      stop();
   }
}

Here is the call graph for this function:

Member Function Documentation

format_result()

void fc::rpc::cli::format_result	(	const string &	method,
		std::function< string(variant, const variants &)>	formatter )

Definition at line 79 of file cli.cpp.

{
   _result_formatters[method] = formatter;
}

getline()

void fc::rpc::cli::getline ( const fc::string & prompt, fc::string & line )

virtual

Definition at line 191 of file cli.cpp.

{
   // getting file descriptor for C++ streams is near impossible
   // so we just assume it's the same as the C stream...
#ifdef HAVE_READLINE
#ifndef WIN32   
   if( isatty( fileno( stdin ) ) )
#else
   // it's implied by
   // https://msdn.microsoft.com/en-us/library/f4s0ddew.aspx
   // that this is the proper way to do this on Windows, but I have
   // no access to a Windows compiler and thus,
   // no idea if this actually works
   if( _isatty( _fileno( stdin ) ) )
#endif
   {
      rl_attempted_completion_function = cli_completion;
 
      static fc::thread getline_thread("getline");
      getline_thread.async( [&](){
         char* line_read = nullptr;
         std::cout.flush(); //readline doesn't use cin, so we must manually flush _out
         line_read = readline(prompt.c_str());
         if( line_read == nullptr )
            FC_THROW_EXCEPTION( fc::eof_exception, "" );
         rl_bind_key( '\t', rl_complete );
         if( *line_read )
            add_history(line_read);
         line = line_read;
         free(line_read);
      }).wait();
   }
   else
#endif
   {
      std::cout << prompt;
      // sync_call( cin_thread, [&](){ std::getline( *input_stream, line ); }, "getline");
      fc::getline( fc::cin, line );
      return;
   }
}

Here is the call graph for this function:

send_call()

variant fc::rpc::cli::send_call ( api_id_type api_id, string method_name, variants args = variants() )

virtual

makes calls to the remote server

Implements fc::api_connection.

Definition at line 47 of file cli.cpp.

{
   FC_ASSERT(false);
}

send_callback()

variant fc::rpc::cli::send_callback ( uint64_t callback_id, variants args = variants() )

virtual

Implements fc::api_connection.

Definition at line 52 of file cli.cpp.

{
   FC_ASSERT(false);
}

send_notice()

void fc::rpc::cli::send_notice ( uint64_t callback_id, variants args = variants() )

virtual

Implements fc::api_connection.

Definition at line 57 of file cli.cpp.

{
   FC_ASSERT(false);
}

set_prompt()

void fc::rpc::cli::set_prompt

(

const string &

prompt

)

Definition at line 84 of file cli.cpp.

{
   _prompt = prompt;
}

start()

void fc::rpc::cli::start

(

)

Definition at line 62 of file cli.cpp.

{
   cli_commands() = get_method_names(0);
   _run_complete = fc::async( [&](){ run(); } );
}

Here is the call graph for this function:

stop()

void fc::rpc::cli::stop

(

)

Definition at line 68 of file cli.cpp.

{
   _run_complete.cancel();
   _run_complete.wait();
}

Here is the caller graph for this function:

wait()

void fc::rpc::cli::wait

(

)

Definition at line 74 of file cli.cpp.

{
   _run_complete.wait();
}

Here is the caller graph for this function:

---

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

• libraries/fc/include/fc/rpc/cli.hpp
• libraries/fc/src/rpc/cli.cpp