Bitshares-Core  2.0.181105
BitShares blockchain implementation and command-line interface software
Public Member Functions | List of all members
graphene::app::abstract_plugin Class Referenceabstract

#include <plugin.hpp>

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

Public Member Functions

virtual ~abstract_plugin ()
 
virtual std::string plugin_name () const =0
 
virtual std::string plugin_description () const =0
 
virtual void plugin_initialize (const boost::program_options::variables_map &options)=0
 Perform early startup routines and register plugin indexes, callbacks, etc. More...
 
virtual void plugin_startup ()=0
 Begin normal runtime operations. More...
 
virtual void plugin_shutdown ()=0
 Cleanly shut down the plugin. More...
 
virtual void plugin_set_app (application *a)=0
 Register the application instance with 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)=0
 Fill in command line parameters used by the plugin. More...
 

Detailed Description

Definition at line 33 of file plugin.hpp.

Constructor & Destructor Documentation

◆ ~abstract_plugin()

virtual graphene::app::abstract_plugin::~abstract_plugin ( )
inlinevirtual

Definition at line 36 of file plugin.hpp.

Member Function Documentation

◆ plugin_description()

virtual std::string graphene::app::abstract_plugin::plugin_description ( ) const
pure virtual

Implemented in graphene::app::plugin.

◆ plugin_initialize()

virtual void graphene::app::abstract_plugin::plugin_initialize ( const boost::program_options::variables_map &  options)
pure virtual

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

Implemented in graphene::app::plugin.

◆ plugin_name()

virtual std::string graphene::app::abstract_plugin::plugin_name ( ) const
pure virtual

Implemented in graphene::app::plugin.

◆ plugin_set_app()

virtual void graphene::app::abstract_plugin::plugin_set_app ( application a)
pure virtual

Register the application instance with the plugin.

This is called by the framework to set the application.

Implemented in graphene::app::plugin.

◆ plugin_set_program_options()

virtual void graphene::app::abstract_plugin::plugin_set_program_options ( boost::program_options::options_description &  command_line_options,
boost::program_options::options_description &  config_file_options 
)
pure virtual

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.

Implemented in graphene::app::plugin.

◆ plugin_shutdown()

virtual void graphene::app::abstract_plugin::plugin_shutdown ( )
pure virtual

Cleanly shut down the plugin.

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

Implemented in graphene::app::plugin.

◆ plugin_startup()

virtual void graphene::app::abstract_plugin::plugin_startup ( )
pure virtual

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.

Implemented in graphene::app::plugin.


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