scorum::witness::witness_plugin Class Reference

#include <witness_plugin.hpp>

Inheritance diagram for scorum::witness::witness_plugin:

Public Member Functions
	witness_plugin (application *app)
virtual	~witness_plugin ()
std::string	plugin_name () const override
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...
void	set_block_production (bool allow)
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...
Public Member Functions inherited from scorum::app::plugin
	plugin (application *app)
virtual	~plugin () override
chain::database &	database ()
application &	app () const
Public Member Functions inherited from scorum::app::abstract_plugin
virtual	~abstract_plugin ()

Friends
class	detail::witness_plugin_impl

Additional Inherited Members
Protected Member Functions inherited from scorum::app::plugin
void	print_greeting ()
graphene::net::node &	p2p_node ()

Detailed Description

Definition at line 68 of file witness_plugin.hpp.

Constructor & Destructor Documentation

witness_plugin()

scorum::witness::witness_plugin::witness_plugin

(

application *

app

)

Definition at line 373 of file witness_plugin.cpp.

~witness_plugin()

scorum::witness::witness_plugin::~witness_plugin ( )

virtual

Definition at line 379 of file witness_plugin.cpp.

Member Function Documentation

plugin_initialize()

void scorum::witness::witness_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

Reimplemented from scorum::app::plugin.

Definition at line 426 of file witness_plugin.cpp.

plugin_name()

std::string scorum::witness::witness_plugin::plugin_name ( ) const

overridevirtual

Reimplemented from scorum::app::plugin.

Definition at line 421 of file witness_plugin.cpp.

plugin_set_program_options()

void scorum::witness::witness_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.

Reimplemented from scorum::app::plugin.

Definition at line 398 of file witness_plugin.cpp.

plugin_shutdown()

void scorum::witness::witness_plugin::plugin_shutdown ( )

overridevirtual

Cleanly shut down the plugin.

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

Reimplemented from scorum::app::plugin.

Definition at line 484 of file witness_plugin.cpp.

plugin_startup()

void scorum::witness::witness_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.

Reimplemented from scorum::app::plugin.

Definition at line 458 of file witness_plugin.cpp.

set_block_production()

void scorum::witness::witness_plugin::set_block_production ( bool  allow )

inline

Definition at line 79 of file witness_plugin.hpp.

Friends And Related Function Documentation

detail::witness_plugin_impl

friend class detail::witness_plugin_impl

friend

Definition at line 106 of file witness_plugin.hpp.

---

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

• libraries/plugins/witness/include/scorum/witness/witness_plugin.hpp
• libraries/plugins/witness/witness_plugin.cpp