Golos
Разработчикам Статистика Баунти Документация Партнеры Github
Public Member Functions | List of all members
golos::witness_plugin::witness_plugin Class Reference

#include <witness.hpp>

Inheritance diagram for golos::witness_plugin::witness_plugin:
golos::application::plugin golos::application::abstract_plugin

Public Member Functions

 witness_plugin (application *app)
 
 ~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 golos::application::plugin
 plugin (application *app)
 
virtual ~plugin () override
 
chain::databasedatabase ()
 
applicationapp () const
 
- Public Member Functions inherited from golos::application::abstract_plugin
virtual ~abstract_plugin ()
 

Additional Inherited Members

- Protected Member Functions inherited from golos::application::plugin
network::node & p2p_node ()
 

Detailed Description

Definition at line 31 of file witness.hpp.

Constructor & Destructor Documentation

◆ witness_plugin()

golos::witness_plugin::witness_plugin::witness_plugin ( application app)
inline

Definition at line 33 of file witness.hpp.

◆ ~witness_plugin()

golos::witness_plugin::witness_plugin::~witness_plugin ( )
inline

Definition at line 36 of file witness.hpp.

Member Function Documentation

◆ plugin_initialize()

void golos::witness_plugin::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
optionsThe options passed to the application, via configuration files or command line

Reimplemented from golos::application::plugin.

Definition at line 64 of file witness.cpp.

◆ plugin_name()

std::string golos::witness_plugin::witness_plugin::plugin_name ( ) const
overridevirtual

Reimplemented from golos::application::plugin.

Definition at line 58 of file witness.cpp.

◆ plugin_set_program_options()

void golos::witness_plugin::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_optionsAll options this plugin supports taking on the command-line
config_file_optionsAll 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 golos::application::plugin.

Definition at line 28 of file witness.cpp.

◆ plugin_shutdown()

void golos::witness_plugin::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 golos::application::plugin.

Definition at line 163 of file witness.cpp.

◆ plugin_startup()

void golos::witness_plugin::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 golos::application::plugin.

Definition at line 134 of file witness.cpp.

◆ set_block_production()

void golos::witness_plugin::witness_plugin::set_block_production ( bool  allow)
inline

Definition at line 55 of file witness.hpp.


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