scorum::app::plugin Class Reference

#include <plugin.hpp>

Inheritance diagram for scorum::app::plugin:

Public Member Functions
	plugin (application *app)
virtual	~plugin () override
virtual std::string	plugin_name () const override
virtual void	plugin_initialize (const boost::program_options::variables_map &options) override
	Perform early startup routines and register plugin indexes, callbacks, etc. More...
virtual void	plugin_startup () override
	Begin normal runtime operations. More...
virtual void	plugin_shutdown () override
	Cleanly shut down the plugin. More...
virtual void	plugin_set_program_options (boost::program_options::options_description &command_line_options, boost::program_options::options_description &config_file_options) override
	Fill in command line parameters used by the plugin. More...
chain::database &	database ()
application &	app () const
Public Member Functions inherited from scorum::app::abstract_plugin
virtual	~abstract_plugin ()

Protected Member Functions
void	print_greeting ()
graphene::net::node &	p2p_node ()

Detailed Description

Provides basic default implementations of abstract_plugin functions.

Definition at line 102 of file plugin.hpp.

Constructor & Destructor Documentation

plugin()

scorum::app::plugin::plugin

(

application *

app

)

Definition at line 32 of file plugin.cpp.

~plugin()

scorum::app::plugin::~plugin ( )

overridevirtual

Definition at line 38 of file plugin.cpp.

Member Function Documentation

app()

application& scorum::app::plugin::app ( ) const

inline

Definition at line 119 of file plugin.hpp.

database()

chain::database& scorum::app::plugin::database ( )

inline

Definition at line 115 of file plugin.hpp.

p2p_node()

graphene::net::node& scorum::app::plugin::p2p_node ( )

inlineprotected

Definition at line 128 of file plugin.hpp.

plugin_initialize()

void scorum::app::plugin::plugin_initialize ( const boost::program_options::variables_map &  options )

overridevirtual

Perform early startup routines and register plugin indexes, callbacks, etc.

Plugins MUST supply a method initialize() which will be called early in the application startup. This method should contain early setup code such as initializing variables, adding indexes to the database, registering callback methods from the database, adding APIs, etc., as well as applying any options in the options map

This method is called BEFORE the database is open, therefore any routines which require any chain state MUST NOT be called by this method. These routines should be performed in startup() instead.

Parameters

options

The options passed to the application, via configuration files or command line

Implements scorum::app::abstract_plugin.

Reimplemented in scorum::witness::witness_plugin, scorum::tags::tags_plugin, scorum::plugin::raw_block::raw_block_plugin, scorum::plugin::debug_node::debug_node_plugin, scorum::blockchain_monitoring::blockchain_monitoring_plugin, scorum::blockchain_history::blockchain_history_plugin, scorum::plugin::block_info::block_info_plugin, scorum::plugin::auth_util::auth_util_plugin, scorum::account_statistics::account_statistics_plugin, and scorum::account_by_key::account_by_key_plugin.

Definition at line 48 of file plugin.cpp.

plugin_name()

std::string scorum::app::plugin::plugin_name ( ) const

overridevirtual

Implements scorum::app::abstract_plugin.

Reimplemented in scorum::witness::witness_plugin, scorum::tags::tags_plugin, scorum::plugin::raw_block::raw_block_plugin, scorum::plugin::debug_node::debug_node_plugin, scorum::blockchain_monitoring::blockchain_monitoring_plugin, scorum::blockchain_history::blockchain_history_plugin, scorum::plugin::block_info::block_info_plugin, scorum::plugin::auth_util::auth_util_plugin, scorum::account_statistics::account_statistics_plugin, and scorum::account_by_key::account_by_key_plugin.

Definition at line 43 of file plugin.cpp.

plugin_set_program_options()

void scorum::app::plugin::plugin_set_program_options ( boost::program_options::options_description &  command_line_options, boost::program_options::options_description &  config_file_options  )

overridevirtual

Fill in command line parameters used by the plugin.

Parameters

command_line_options	All options this plugin supports taking on the command-line
config_file_options	All options this plugin supports storing in a configuration file

This method populates its arguments with any command-line and configuration file options the plugin supports. If a plugin does not need these options, it may simply provide an empty implementation of this method.

Implements scorum::app::abstract_plugin.

Reimplemented in scorum::witness::witness_plugin, scorum::tags::tags_plugin, scorum::plugin::debug_node::debug_node_plugin, scorum::blockchain_monitoring::blockchain_monitoring_plugin, scorum::blockchain_history::blockchain_history_plugin, scorum::account_statistics::account_statistics_plugin, and scorum::account_by_key::account_by_key_plugin.

Definition at line 63 of file plugin.cpp.

plugin_shutdown()

void scorum::app::plugin::plugin_shutdown ( )

overridevirtual

Cleanly shut down the plugin.

This is called to request a clean shutdown (e.g. due to SIGINT or SIGTERM).

Implements scorum::app::abstract_plugin.

Reimplemented in scorum::witness::witness_plugin, scorum::plugin::raw_block::raw_block_plugin, scorum::plugin::debug_node::debug_node_plugin, scorum::plugin::block_info::block_info_plugin, and scorum::plugin::auth_util::auth_util_plugin.

Definition at line 58 of file plugin.cpp.

plugin_startup()

void scorum::app::plugin::plugin_startup ( )

overridevirtual

Begin normal runtime operations.

Plugins MUST supply a method startup() which will be called at the end of application startup. This method should contain code which schedules any tasks, or requires chain state.

Implements scorum::app::abstract_plugin.

Reimplemented in scorum::witness::witness_plugin, scorum::tags::tags_plugin, scorum::plugin::raw_block::raw_block_plugin, scorum::plugin::debug_node::debug_node_plugin, scorum::blockchain_monitoring::blockchain_monitoring_plugin, scorum::blockchain_history::blockchain_history_plugin, scorum::plugin::block_info::block_info_plugin, scorum::plugin::auth_util::auth_util_plugin, scorum::account_statistics::account_statistics_plugin, and scorum::account_by_key::account_by_key_plugin.

Definition at line 53 of file plugin.cpp.

print_greeting()

void scorum::app::plugin::print_greeting ( )

protected

Definition at line 69 of file plugin.cpp.

---

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

• libraries/app/include/scorum/app/plugin.hpp
• libraries/app/plugin.cpp