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

#include <debug_witness.hpp>

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

Public Member Functions

 ~debug_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...
 
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...
 
void set_json_object_stream (const std::string &filename)
 
void flush_json_object_stream ()
 
- Public Member Functions inherited from graphene::app::plugin
 plugin ()
 
virtual ~plugin () override
 
virtual std::string plugin_description () const override
 
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 ()
 

Additional Inherited Members

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

Detailed Description

Definition at line 35 of file debug_witness.hpp.

Constructor & Destructor Documentation

debug_witness_plugin::~debug_witness_plugin ( )

Definition at line 41 of file debug_witness.cpp.

Member Function Documentation

void debug_witness_plugin::flush_json_object_stream ( )

Definition at line 151 of file debug_witness.cpp.

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

Definition at line 60 of file debug_witness.cpp.

std::string debug_witness_plugin::plugin_name ( ) const
overridevirtual

Reimplemented from graphene::app::plugin.

Definition at line 55 of file debug_witness.cpp.

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

Definition at line 43 of file debug_witness.cpp.

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

Definition at line 157 of file debug_witness.cpp.

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

Definition at line 92 of file debug_witness.cpp.

void debug_witness_plugin::set_json_object_stream ( const std::string &  filename)

Definition at line 141 of file debug_witness.cpp.


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