BitShares-Core  4.0.0
BitShares blockchain implementation and command-line interface software
Public Member Functions | Public Attributes | Friends | List of all members
graphene::es_objects::es_objects_plugin Class Reference

#include <es_objects.hpp>

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

Public Member Functions

 es_objects_plugin ()
 
virtual ~es_objects_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::databasedatabase ()
 
applicationapp () const
 
- Public Member Functions inherited from graphene::app::abstract_plugin
virtual ~abstract_plugin ()
 

Public Attributes

std::unique_ptr< detail::es_objects_plugin_implmy
 

Friends

class detail::es_objects_plugin_impl
 

Additional Inherited Members

- Protected Member Functions inherited from graphene::app::plugin
net::nodep2p_node ()
 

Detailed Description

Definition at line 38 of file es_objects.hpp.

Constructor & Destructor Documentation

graphene::es_objects::es_objects_plugin::es_objects_plugin ( )

Definition at line 274 of file es_objects.cpp.

graphene::es_objects::es_objects_plugin::~es_objects_plugin ( )
virtual

Definition at line 279 of file es_objects.cpp.

Member Function Documentation

std::string graphene::es_objects::es_objects_plugin::plugin_description ( ) const
overridevirtual

Reimplemented from graphene::app::plugin.

Definition at line 287 of file es_objects.cpp.

void graphene::es_objects::es_objects_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 321 of file es_objects.cpp.

std::string graphene::es_objects::es_objects_plugin::plugin_name ( ) const
overridevirtual

Reimplemented from graphene::app::plugin.

Definition at line 283 of file es_objects.cpp.

void graphene::es_objects::es_objects_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 292 of file es_objects.cpp.

void graphene::es_objects::es_objects_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 395 of file es_objects.cpp.

Friends And Related Function Documentation

friend class detail::es_objects_plugin_impl
friend

Definition at line 52 of file es_objects.hpp.

Member Data Documentation

std::unique_ptr<detail::es_objects_plugin_impl> graphene::es_objects::es_objects_plugin::my

Definition at line 53 of file es_objects.hpp.


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