Wire Sysio Wire Sysion 1.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
appbase::abstract_plugin Class Referenceabstract

#include <plugin.hpp>

Inheritance diagram for appbase::abstract_plugin:
Inheritance graph
[legend]

Public Types

enum  state { registered , initialized , started , stopped }
 

Public Member Functions

virtual ~abstract_plugin ()
 
virtual state get_state () const =0
 
virtual const std::string & name () const =0
 
virtual void set_program_options (options_description &cli, options_description &cfg)=0
 
virtual void initialize (const variables_map &options)=0
 
virtual void handle_sighup ()=0
 
virtual void startup ()=0
 
virtual void shutdown ()=0
 

Detailed Description

Definition at line 28 of file plugin.hpp.

Member Enumeration Documentation

◆ state

enum appbase::abstract_plugin::state
Enumerator
registered 

the plugin is constructed but doesn't do anything

initialized 

the plugin has initialized any state required but is idle

started 

the plugin is actively running

stopped 

the plugin is no longer running

Definition at line 30 of file plugin.hpp.

30 {
31 registered,
32 initialized,
33 started,
34 stopped
35 };
appbase::abstract_plugin::stopped
@ stopped
the plugin is no longer running
Definition plugin.hpp:34
appbase::abstract_plugin::started
@ started
the plugin is actively running
Definition plugin.hpp:33
appbase::abstract_plugin::initialized
@ initialized
the plugin has initialized any state required but is idle
Definition plugin.hpp:32
appbase::abstract_plugin::registered
@ registered
the plugin is constructed but doesn't do anything
Definition plugin.hpp:31

Constructor & Destructor Documentation

◆ ~abstract_plugin()

virtual appbase::abstract_plugin::~abstract_plugin ( )
inlinevirtual

Definition at line 37 of file plugin.hpp.

37{}

Member Function Documentation

◆ get_state()

virtual state appbase::abstract_plugin::get_state ( ) const
pure virtual

Implemented in appbase::plugin< Impl >, appbase::plugin< chain_api_plugin >, appbase::plugin< chain_plugin >, appbase::plugin< db_size_api_plugin >, appbase::plugin< http_client_plugin >, appbase::plugin< http_plugin >, appbase::plugin< login_plugin >, appbase::plugin< net_api_plugin >, appbase::plugin< net_plugin >, appbase::plugin< producer_api_plugin >, appbase::plugin< producer_plugin >, appbase::plugin< resource_monitor_plugin >, appbase::plugin< state_history_plugin >, appbase::plugin< sub_chain_plugin >, appbase::plugin< template_plugin >, appbase::plugin< test_control_api_plugin >, appbase::plugin< test_control_plugin >, appbase::plugin< trace_api_plugin >, appbase::plugin< trace_api_rpc_plugin >, appbase::plugin< txn_test_gen_plugin >, appbase::plugin< wallet_api_plugin >, and appbase::plugin< wallet_plugin >.

◆ handle_sighup()

virtual void appbase::abstract_plugin::handle_sighup ( )
pure virtual

Implemented in appbase::plugin< Impl >, appbase::plugin< chain_api_plugin >, appbase::plugin< chain_plugin >, appbase::plugin< db_size_api_plugin >, appbase::plugin< http_client_plugin >, appbase::plugin< http_plugin >, appbase::plugin< login_plugin >, appbase::plugin< net_api_plugin >, appbase::plugin< net_plugin >, appbase::plugin< producer_api_plugin >, appbase::plugin< producer_plugin >, appbase::plugin< resource_monitor_plugin >, appbase::plugin< state_history_plugin >, appbase::plugin< sub_chain_plugin >, appbase::plugin< template_plugin >, appbase::plugin< test_control_api_plugin >, appbase::plugin< test_control_plugin >, appbase::plugin< trace_api_plugin >, appbase::plugin< trace_api_rpc_plugin >, appbase::plugin< txn_test_gen_plugin >, appbase::plugin< wallet_api_plugin >, appbase::plugin< wallet_plugin >, sysio::chain_plugin, sysio::http_plugin, sysio::net_plugin, sysio::producer_plugin, sysio::trace_api_plugin, and sysio::trace_api_rpc_plugin.

◆ initialize()

virtual void appbase::abstract_plugin::initialize ( const variables_map & options)
pure virtual

Implemented in appbase::plugin< Impl >, appbase::plugin< chain_api_plugin >, appbase::plugin< chain_plugin >, appbase::plugin< db_size_api_plugin >, appbase::plugin< http_client_plugin >, appbase::plugin< http_plugin >, appbase::plugin< login_plugin >, appbase::plugin< net_api_plugin >, appbase::plugin< net_plugin >, appbase::plugin< producer_api_plugin >, appbase::plugin< producer_plugin >, appbase::plugin< resource_monitor_plugin >, appbase::plugin< state_history_plugin >, appbase::plugin< sub_chain_plugin >, appbase::plugin< template_plugin >, appbase::plugin< test_control_api_plugin >, appbase::plugin< test_control_plugin >, appbase::plugin< trace_api_plugin >, appbase::plugin< trace_api_rpc_plugin >, appbase::plugin< txn_test_gen_plugin >, appbase::plugin< wallet_api_plugin >, and appbase::plugin< wallet_plugin >.

◆ name()

virtual const std::string & appbase::abstract_plugin::name ( ) const
pure virtual

Implemented in appbase::plugin< Impl >, appbase::plugin< chain_api_plugin >, appbase::plugin< chain_plugin >, appbase::plugin< db_size_api_plugin >, appbase::plugin< http_client_plugin >, appbase::plugin< http_plugin >, appbase::plugin< login_plugin >, appbase::plugin< net_api_plugin >, appbase::plugin< net_plugin >, appbase::plugin< producer_api_plugin >, appbase::plugin< producer_plugin >, appbase::plugin< resource_monitor_plugin >, appbase::plugin< state_history_plugin >, appbase::plugin< sub_chain_plugin >, appbase::plugin< template_plugin >, appbase::plugin< test_control_api_plugin >, appbase::plugin< test_control_plugin >, appbase::plugin< trace_api_plugin >, appbase::plugin< trace_api_rpc_plugin >, appbase::plugin< txn_test_gen_plugin >, appbase::plugin< wallet_api_plugin >, and appbase::plugin< wallet_plugin >.

◆ set_program_options()

virtual void appbase::abstract_plugin::set_program_options ( options_description & cli,
options_description & cfg )
pure virtual

Implemented in chain_plugin, net_plugin, sysio::chain_api_plugin, sysio::chain_plugin, sysio::db_size_api_plugin, sysio::http_client_plugin, sysio::http_plugin, sysio::login_plugin, sysio::net_api_plugin, sysio::net_plugin, sysio::producer_api_plugin, sysio::resource_monitor_plugin, sysio::state_history_plugin, sysio::sub_chain_plugin, sysio::template_plugin, sysio::test_control_api_plugin, sysio::test_control_plugin, sysio::trace_api_plugin, sysio::trace_api_rpc_plugin, sysio::wallet_api_plugin, and sysio::wallet_plugin.

◆ shutdown()

virtual void appbase::abstract_plugin::shutdown ( )
pure virtual

Implemented in appbase::plugin< Impl >, appbase::plugin< chain_api_plugin >, appbase::plugin< chain_plugin >, appbase::plugin< db_size_api_plugin >, appbase::plugin< http_client_plugin >, appbase::plugin< http_plugin >, appbase::plugin< login_plugin >, appbase::plugin< net_api_plugin >, appbase::plugin< net_plugin >, appbase::plugin< producer_api_plugin >, appbase::plugin< producer_plugin >, appbase::plugin< resource_monitor_plugin >, appbase::plugin< state_history_plugin >, appbase::plugin< sub_chain_plugin >, appbase::plugin< template_plugin >, appbase::plugin< test_control_api_plugin >, appbase::plugin< test_control_plugin >, appbase::plugin< trace_api_plugin >, appbase::plugin< trace_api_rpc_plugin >, appbase::plugin< txn_test_gen_plugin >, appbase::plugin< wallet_api_plugin >, and appbase::plugin< wallet_plugin >.

◆ startup()

virtual void appbase::abstract_plugin::startup ( )
pure virtual

Implemented in appbase::plugin< Impl >, appbase::plugin< chain_api_plugin >, appbase::plugin< chain_plugin >, appbase::plugin< db_size_api_plugin >, appbase::plugin< http_client_plugin >, appbase::plugin< http_plugin >, appbase::plugin< login_plugin >, appbase::plugin< net_api_plugin >, appbase::plugin< net_plugin >, appbase::plugin< producer_api_plugin >, appbase::plugin< producer_plugin >, appbase::plugin< resource_monitor_plugin >, appbase::plugin< state_history_plugin >, appbase::plugin< sub_chain_plugin >, appbase::plugin< template_plugin >, appbase::plugin< test_control_api_plugin >, appbase::plugin< test_control_plugin >, appbase::plugin< trace_api_plugin >, appbase::plugin< trace_api_rpc_plugin >, appbase::plugin< txn_test_gen_plugin >, appbase::plugin< wallet_api_plugin >, and appbase::plugin< wallet_plugin >.

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