BitShares-Core  6.0.1
BitShares blockchain implementation and command-line interface software
Public Member Functions | List of all members
graphene::app::login_api Class Reference

The login_api class implements the bottom layer of the RPC API. More...

#include <api.hpp>

Public Member Functions

 login_api (application &a)
 ~login_api ()
bool login (const string &user, const string &password)
 Authenticate to the RPC server. More...
fc::api< block_apiblock () const
 Retrieve the network block API. More...
fc::api< network_broadcast_apinetwork_broadcast () const
 Retrieve the network broadcast API. More...
fc::api< database_apidatabase () const
 Retrieve the database API. More...
fc::api< history_apihistory () const
 Retrieve the history API. More...
fc::api< network_node_apinetwork_node () const
 Retrieve the network node API. More...
fc::api< crypto_apicrypto () const
 Retrieve the cryptography API. More...
fc::api< asset_apiasset () const
 Retrieve the asset API. More...
fc::api< orders_apiorders () const
 Retrieve the orders API. More...
fc::api< graphene::debug_witness::debug_apidebug () const
 Retrieve the debug API (if available) More...
fc::api< custom_operations_apicustom_operations () const
 Retrieve the custom operations API. More...
void enable_api (const string &api_name)
 Called to enable an API, not reflected. More...

Detailed Description

The login_api class implements the bottom layer of the RPC API.

All other APIs must be requested from this API.

Definition at line 625 of file api.hpp.

Constructor & Destructor Documentation

◆ login_api()

graphene::app::login_api::login_api ( application a)

Definition at line 58 of file api.cpp.

◆ ~login_api()

graphene::app::login_api::~login_api ( )

Definition at line 63 of file api.cpp.

Member Function Documentation

◆ asset()

fc::api< asset_api > graphene::app::login_api::asset ( ) const

Retrieve the asset API.

Definition at line 295 of file api.cpp.

◆ block()

fc::api< block_api > graphene::app::login_api::block ( ) const

Retrieve the network block API.

Definition at line 265 of file api.cpp.

◆ crypto()

fc::api< crypto_api > graphene::app::login_api::crypto ( ) const

Retrieve the cryptography API.

Definition at line 289 of file api.cpp.

◆ custom_operations()

fc::api< custom_operations_api > graphene::app::login_api::custom_operations ( ) const

Retrieve the custom operations API.

Definition at line 313 of file api.cpp.

◆ database()

fc::api< database_api > graphene::app::login_api::database ( ) const

Retrieve the database API.

Definition at line 277 of file api.cpp.

◆ debug()

fc::api< graphene::debug_witness::debug_api > graphene::app::login_api::debug ( ) const

Retrieve the debug API (if available)

Definition at line 307 of file api.cpp.

◆ enable_api()

void graphene::app::login_api::enable_api ( const string &  api_name)

Called to enable an API, not reflected.

Definition at line 89 of file api.cpp.

◆ history()

fc::api< history_api > graphene::app::login_api::history ( ) const

Retrieve the history API.

Definition at line 283 of file api.cpp.

◆ login()

bool graphene::app::login_api::login ( const string &  user,
const string &  password 

Authenticate to the RPC server.

userUsername to login with
passwordPassword to login with
True if logged in successfully; false otherwise
This must be called prior to requesting other APIs. Other APIs may not be accessible until the client has sucessfully authenticated.

Definition at line 67 of file api.cpp.

◆ network_broadcast()

fc::api< network_broadcast_api > graphene::app::login_api::network_broadcast ( ) const

Retrieve the network broadcast API.

Definition at line 259 of file api.cpp.

◆ network_node()

fc::api< network_node_api > graphene::app::login_api::network_node ( ) const

Retrieve the network node API.

Definition at line 271 of file api.cpp.

◆ orders()

fc::api< orders_api > graphene::app::login_api::orders ( ) const

Retrieve the orders API.

Definition at line 301 of file api.cpp.

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