graphene::template_plugin::template_plugin Class Reference

#include <template_plugin.hpp>

Inheritance diagram for graphene::template_plugin::template_plugin:

Public Member Functions
	template_plugin ()
virtual	~template_plugin ()
std::string	plugin_name () const override
std::string	plugin_description () const override
virtual 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...
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...
Public Member Functions inherited from graphene::app::plugin
	plugin ()
virtual	~plugin () override
virtual void	plugin_shutdown () override
	Cleanly shut down the plugin. More...
virtual void	plugin_set_app (application *app) override
	Register the application instance with the plugin. More...
chain::database &	database ()
application &	app () const
Public Member Functions inherited from graphene::app::abstract_plugin
virtual	~abstract_plugin ()

Public Attributes
std::unique_ptr< detail::template_plugin_impl >	my

Friends
class	detail::template_plugin_impl

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

Detailed Description

Definition at line 52 of file template_plugin.hpp.

Constructor & Destructor Documentation

graphene::template_plugin::template_plugin::template_plugin

(

)

Definition at line 67 of file template_plugin.cpp.

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

virtual

Definition at line 72 of file template_plugin.cpp.

Member Function Documentation

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

overridevirtual

Reimplemented from graphene::app::plugin.

Definition at line 80 of file template_plugin.cpp.

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

options

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

Reimplemented from graphene::app::plugin.

Definition at line 96 of file template_plugin.cpp.

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

overridevirtual

Reimplemented from graphene::app::plugin.

Definition at line 76 of file template_plugin.cpp.

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_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 graphene::app::plugin.

Definition at line 85 of file template_plugin.cpp.

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 107 of file template_plugin.cpp.

Friends And Related Function Documentation

friend class detail::template_plugin_impl

friend

Definition at line 66 of file template_plugin.hpp.

Member Data Documentation

std::unique_ptr<detail::template_plugin_impl> graphene::template_plugin::template_plugin::my

Definition at line 67 of file template_plugin.hpp.

---

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

• libraries/plugins/template_plugin/include/graphene/template_plugin/template_plugin.hpp
• libraries/plugins/template_plugin/template_plugin.cpp