BitShares-Core  6.1.0
BitShares blockchain implementation and command-line interface software
Public Member Functions | List of all members
graphene::template_plugin::template_plugin Class Reference

#include <template_plugin.hpp>

Inheritance diagram for graphene::template_plugin::template_plugin:
graphene::app::plugin graphene::app::abstract_plugin

Public Member Functions

 template_plugin (graphene::app::application &app)
 
 ~template_plugin () override
 
std::string plugin_name () const override
 Get the name of the plugin. More...
 
std::string plugin_description () const override
 Get the description of the plugin. More...
 
void plugin_set_program_options (boost::program_options::options_description &cli, boost::program_options::options_description &cfg) override
 Fill in command line parameters used by the plugin. More...
 
void plugin_initialize (const boost::program_options::variables_map &options) override
 Perform early startup routines and register plugin indexes, callbacks, etc. More...
 
void plugin_startup () override
 Begin normal runtime operations. More...
 
void plugin_shutdown () override
 Cleanly shut down the plugin. More...
 
- Public Member Functions inherited from graphene::app::plugin
chain::databasedatabase ()
 
- Public Member Functions inherited from graphene::app::abstract_plugin
 abstract_plugin (application &a)
 
virtual ~abstract_plugin ()=default
 
applicationapp () const
 Get a reference of the application bound to the plugin. More...
 

Additional Inherited Members

- Protected Member Functions inherited from graphene::app::plugin
net::node_ptr p2p_node () const
 
- Protected Attributes inherited from graphene::app::abstract_plugin
application_app
 

Detailed Description

Definition at line 52 of file template_plugin.hpp.

Constructor & Destructor Documentation

◆ template_plugin()

graphene::template_plugin::template_plugin::template_plugin ( graphene::app::application app)
explicit

Definition at line 72 of file template_plugin.cpp.

◆ ~template_plugin()

graphene::template_plugin::template_plugin::~template_plugin ( )
override

Definition at line 79 of file template_plugin.cpp.

Member Function Documentation

◆ plugin_description()

std::string graphene::template_plugin::template_plugin::plugin_description ( ) const
overridevirtual

Get the description of the plugin.

Reimplemented from graphene::app::plugin.

Definition at line 88 of file template_plugin.cpp.

◆ plugin_initialize()

void graphene::template_plugin::template_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 graphene::app::plugin.

Definition at line 104 of file template_plugin.cpp.

◆ plugin_name()

std::string graphene::template_plugin::template_plugin::plugin_name ( ) const
overridevirtual

Get the name of the plugin.

Reimplemented from graphene::app::plugin.

Definition at line 84 of file template_plugin.cpp.

◆ plugin_set_program_options()

void graphene::template_plugin::template_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 graphene::app::plugin.

Definition at line 93 of file template_plugin.cpp.

◆ plugin_shutdown()

void graphene::template_plugin::template_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 graphene::app::plugin.

Definition at line 121 of file template_plugin.cpp.

◆ plugin_startup()

void graphene::template_plugin::template_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 graphene::app::plugin.

Definition at line 116 of file template_plugin.cpp.


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