DECENT
Functions
LoginAPI

Functions

string graphene::app::login_api::info ()
 Get the name of the API. More...
 
bool graphene::app::login_api::login (const string &user, const string &password)
 Authenticate to the RPC server. More...
 
fc::api< network_broadcast_api > graphene::app::login_api::network_broadcast () const
 Retrieve the network broadcast API. More...
 
fc::api< database_api > graphene::app::login_api::database () const
 Retrieve the database API. More...
 
fc::api< history_api > graphene::app::login_api::history () const
 Retrieve the history API. More...
 
fc::api< network_node_api > graphene::app::login_api::network_node () const
 Retrieve the network node API. More...
 
fc::api< crypto_api > graphene::app::login_api::crypto () const
 Retrieve the cryptography API. More...
 
fc::api< messaging_api > graphene::app::login_api::messaging () const
 Retrieve the messaging API. More...
 
fc::api< monitoring_api > graphene::app::login_api::monitoring () const
 Retrieve the monitoring API. More...
 

Detailed Description

Function Documentation

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

Retrieve the cryptography API.

Definition at line 245 of file api.cpp.

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

Retrieve the database API.

Definition at line 233 of file api.cpp.

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

Retrieve the history API.

Definition at line 239 of file api.cpp.

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

Get the name of the API.

Returns
the name of the API

Definition at line 457 of file api.hpp.

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 48 of file api.cpp.

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

Retrieve the messaging API.

Definition at line 251 of file api.cpp.

fc::api< monitoring_api > graphene::app::login_api::monitoring ( ) const

Retrieve the monitoring API.

Definition at line 257 of file api.cpp.

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

Retrieve the network broadcast API.

Definition at line 221 of file api.cpp.

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

Retrieve the network node API.

Definition at line 227 of file api.cpp.