Scorum
Public Member Functions | Friends | List of all members
scorum::account_statistics::account_statistics_plugin Class Reference

#include <account_statistics_plugin.hpp>

Inheritance diagram for scorum::account_statistics::account_statistics_plugin:
scorum::app::plugin scorum::app::abstract_plugin

Public Member Functions

 account_statistics_plugin (application *app)
 
virtual ~account_statistics_plugin ()
 
virtual std::string plugin_name () 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...
 
const flat_set< uint32_t > & get_tracked_buckets () const
 
uint32_t get_max_history_per_bucket () const
 
- Public Member Functions inherited from scorum::app::plugin
 plugin (application *app)
 
virtual ~plugin () override
 
virtual void plugin_shutdown () override
 Cleanly shut down the plugin. More...
 
chain::databasedatabase ()
 
applicationapp () const
 
- Public Member Functions inherited from scorum::app::abstract_plugin
virtual ~abstract_plugin ()
 

Friends

class detail::account_statistics_plugin_impl
 

Additional Inherited Members

- Protected Member Functions inherited from scorum::app::plugin
void print_greeting ()
 
graphene::net::node & p2p_node ()
 

Detailed Description

Definition at line 26 of file account_statistics_plugin.hpp.

Constructor & Destructor Documentation

◆ account_statistics_plugin()

scorum::account_statistics::account_statistics_plugin::account_statistics_plugin ( application app)

Definition at line 85 of file account_statistics_plugin.cpp.

◆ ~account_statistics_plugin()

scorum::account_statistics::account_statistics_plugin::~account_statistics_plugin ( )
virtual

Definition at line 91 of file account_statistics_plugin.cpp.

Member Function Documentation

◆ get_max_history_per_bucket()

uint32_t scorum::account_statistics::account_statistics_plugin::get_max_history_per_bucket ( ) const

Definition at line 131 of file account_statistics_plugin.cpp.

◆ get_tracked_buckets()

const flat_set< uint32_t > & scorum::account_statistics::account_statistics_plugin::get_tracked_buckets ( ) const

Definition at line 126 of file account_statistics_plugin.cpp.

◆ plugin_initialize()

void scorum::account_statistics::account_statistics_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 scorum::app::plugin.

Definition at line 110 of file account_statistics_plugin.cpp.

◆ plugin_name()

virtual std::string scorum::account_statistics::account_statistics_plugin::plugin_name ( ) const
inlineoverridevirtual

Reimplemented from scorum::app::plugin.

Definition at line 32 of file account_statistics_plugin.hpp.

◆ plugin_set_program_options()

void scorum::account_statistics::account_statistics_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 scorum::app::plugin.

Definition at line 95 of file account_statistics_plugin.cpp.

◆ plugin_startup()

void scorum::account_statistics::account_statistics_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 scorum::app::plugin.

Definition at line 121 of file account_statistics_plugin.cpp.

Friends And Related Function Documentation

◆ detail::account_statistics_plugin_impl

Definition at line 45 of file account_statistics_plugin.hpp.


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