BitShares-Core  4.0.0
BitShares blockchain implementation and command-line interface software
Classes | Public Member Functions | Public Attributes | List of all members
fc::api_connection Class Referenceabstract

#include <api_connection.hpp>

Inheritance diagram for fc::api_connection:
fc::local_api_connection fc::rpc::cli fc::rpc::websocket_api_connection

Public Member Functions

 api_connection (uint32_t max_depth)
 
virtual ~api_connection ()
 
template<typename T >
api< T > get_remote_api (api_id_type api_id=0)
 
virtual variant send_call (api_id_type api_id, string method_name, variants args=variants())=0
 
virtual variant send_callback (uint64_t callback_id, variants args=variants())=0
 
virtual void send_notice (uint64_t callback_id, variants args=variants())=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
 

Public Attributes

fc::signal< void()> closed
 
const uint32_t _max_conversion_depth
 

Detailed Description

Definition at line 240 of file api_connection.hpp.

Constructor & Destructor Documentation

fc::api_connection::api_connection ( uint32_t  max_depth)
inline

Definition at line 243 of file api_connection.hpp.

virtual fc::api_connection::~api_connection ( )
inlinevirtual

Definition at line 244 of file api_connection.hpp.

Member Function Documentation

std::vector<std::string> fc::api_connection::get_method_names ( api_id_type  local_api_id = 0) const
inline

Definition at line 295 of file api_connection.hpp.

template<typename T >
api<T> fc::api_connection::get_remote_api ( api_id_type  api_id = 0)
inline

Definition at line 248 of file api_connection.hpp.

variant fc::api_connection::receive_call ( api_id_type  api_id,
const string &  method_name,
const variants args = variants() 
) const
inline

Definition at line 260 of file api_connection.hpp.

variant fc::api_connection::receive_callback ( uint64_t  callback_id,
const variants args = variants() 
) const
inline

Definition at line 265 of file api_connection.hpp.

void fc::api_connection::receive_notice ( uint64_t  callback_id,
const variants args = variants() 
) const
inline

Definition at line 270 of file api_connection.hpp.

template<typename Interface >
api_id_type fc::api_connection::register_api ( const Interface &  a)
inline

Definition at line 277 of file api_connection.hpp.

template<typename Signature >
uint64_t fc::api_connection::register_callback ( const std::function< Signature > &  cb)
inline

Definition at line 289 of file api_connection.hpp.

virtual variant fc::api_connection::send_call ( api_id_type  api_id,
string  method_name,
variants  args = variants() 
)
pure virtual

makes calls to the remote server

Implemented in fc::local_api_connection, fc::rpc::cli, and fc::rpc::websocket_api_connection.

virtual variant fc::api_connection::send_callback ( uint64_t  callback_id,
variants  args = variants() 
)
pure virtual
virtual void fc::api_connection::send_notice ( uint64_t  callback_id,
variants  args = variants() 
)
pure virtual

Member Data Documentation

const uint32_t fc::api_connection::_max_conversion_depth

Definition at line 298 of file api_connection.hpp.

fc::signal<void()> fc::api_connection::closed

Definition at line 297 of file api_connection.hpp.


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