group LoginAPI

Summary

Members Descriptions
public boollogin(const string & user,const string & password) Authenticate to the RPC server.
public fc::api< network_broadcast_api >network_broadcast() const Retrieve the network broadcast API.
public fc::api< database_api >database() const Retrieve the database API.
public fc::api< history_api >history() const Retrieve the history API.
public fc::api< network_node_api >network_node() const Retrieve the network node API.
public fc::api< crypto_api >crypto() const Retrieve the cryptography API.
public fc::api< messaging_api >messaging() const Retrieve the messaging API.
public fc::api< graphene::debug_miner::debug_api >debug() const Retrieve the debug API (if available)
private voidenable_api(const string & api_name) Called to enable an API, not reflected.

Members

public boollogin(const string & user,const string & password)

Authenticate to the RPC server.

Parameters

  • user Username to login with

  • password Password to login with

Returns

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.

public fc::api< network_broadcast_api >network_broadcast() const

Retrieve the network broadcast API.

public fc::api< database_api >database() const

Retrieve the database API.

public fc::api< history_api >history() const

Retrieve the history API.

public fc::api< network_node_api >network_node() const

Retrieve the network node API.

public fc::api< crypto_api >crypto() const

Retrieve the cryptography API.

public fc::api< messaging_api >messaging() const

Retrieve the messaging API.

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

Retrieve the debug API (if available)

private voidenable_api(const string & api_name)

Called to enable an API, not reflected.

Parameters

  • api_name