Golos
Разработчикам Статистика Баунти Документация Партнеры Github
Public Member Functions | Public Attributes | Friends | List of all members
golos::follow::follow_plugin Class Reference

#include <follow_plugin.hpp>

Inheritance diagram for golos::follow::follow_plugin:
golos::application::plugin golos::application::abstract_plugin

Public Member Functions

 follow_plugin (application *app)
 
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...
 
- Public Member Functions inherited from golos::application::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 golos::application::abstract_plugin
virtual ~abstract_plugin ()
 

Public Attributes

std::unique_ptr< detail::follow_plugin_implmy
 
uint32_t max_feed_size = 500
 

Friends

class detail::follow_plugin_impl
 

Additional Inherited Members

- Protected Member Functions inherited from golos::application::plugin
network::node & p2p_node ()
 

Detailed Description

Definition at line 17 of file follow_plugin.hpp.

Constructor & Destructor Documentation

◆ follow_plugin()

golos::follow::follow_plugin::follow_plugin ( application app)

Definition at line 348 of file follow_plugin.cpp.

Member Function Documentation

◆ plugin_initialize()

void golos::follow::follow_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 golos::application::plugin.

Definition at line 361 of file follow_plugin.cpp.

◆ plugin_name()

std::string golos::follow::follow_plugin::plugin_name ( ) const
inlineoverridevirtual

Reimplemented from golos::application::plugin.

Definition at line 21 of file follow_plugin.hpp.

◆ plugin_set_program_options()

void golos::follow::follow_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 golos::application::plugin.

Definition at line 352 of file follow_plugin.cpp.

◆ plugin_startup()

void golos::follow::follow_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 golos::application::plugin.

Definition at line 384 of file follow_plugin.cpp.

Friends And Related Function Documentation

◆ detail::follow_plugin_impl

friend class detail::follow_plugin_impl
friend

Definition at line 33 of file follow_plugin.hpp.

Member Data Documentation

◆ max_feed_size

uint32_t golos::follow::follow_plugin::max_feed_size = 500

Definition at line 36 of file follow_plugin.hpp.

◆ my

std::unique_ptr<detail::follow_plugin_impl> golos::follow::follow_plugin::my

Definition at line 35 of file follow_plugin.hpp.


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