DECENT
Functions
LoginAPI

Functions

string graphene::app::login_api::info ()
 
bool graphene::app::login_api::login (const string &user, const string &password)
 Authenticate to the RPC server. More...
 
fc::api< network_broadcast_apigraphene::app::login_api::network_broadcast () const
 Retrieve the network broadcast API. More...
 
fc::api< database_apigraphene::app::login_api::database () const
 Retrieve the database API. More...
 
fc::api< history_apigraphene::app::login_api::history () const
 Retrieve the history API. More...
 
fc::api< network_node_apigraphene::app::login_api::network_node () const
 Retrieve the network node API. More...
 
fc::api< crypto_apigraphene::app::login_api::crypto () const
 Retrieve the cryptography API. More...
 
fc::api< messaging_apigraphene::app::login_api::messaging () const
 Retrieve the messaging API. More...
 
fc::api< graphene::debug_miner::debug_api > graphene::app::login_api::debug () const
 Retrieve the debug API (if available). More...
 

Detailed Description

Function Documentation

◆ crypto()

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

Retrieve the cryptography API.

Definition at line 262 of file api.cpp.

◆ database()

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

Retrieve the database API.

Definition at line 250 of file api.cpp.

◆ debug()

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

Retrieve the debug API (if available).

Definition at line 268 of file api.cpp.

◆ history()

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

Retrieve the history API.

Definition at line 256 of file api.cpp.

◆ info()

string graphene::app::login_api::info ( )
inline

Get the name of the API.

Returns
the name of the API

Definition at line 478 of file api.hpp.

◆ login()

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

Authenticate to the RPC server.

Note
This must be called prior to requesting other APIs. Other APIs may not be accessible until the client has sucessfully authenticated.
Parameters
userusername to login with
passwordpassword to login with
Returns
true if logged in successfully, false otherwise

Definition at line 62 of file api.cpp.

◆ messaging()

fc::api< graphene::app::messaging_api > graphene::app::login_api::messaging ( ) const

Retrieve the messaging API.

Definition at line 274 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 238 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 244 of file api.cpp.