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

#include <private_message_plugin.hpp>

Inheritance diagram for golos::private_message::private_message_plugin:
golos::application::plugin golos::application::abstract_plugin

Public Member Functions

 private_message_plugin (application::application *app)
 
virtual ~private_message_plugin ()
 
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...
 
flat_map< string, string > tracked_accounts () const
 
- 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::private_message_plugin_implmy
 

Friends

class detail::private_message_plugin_impl
 map start_range to end_range More...
 

Additional Inherited Members

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

Detailed Description

This plugin scans the blockchain for custom operations containing a valid message and authorized by the posting key.

Definition at line 168 of file private_message_plugin.hpp.

Constructor & Destructor Documentation

◆ private_message_plugin()

golos::private_message::private_message_plugin::private_message_plugin ( application::application app)

Definition at line 76 of file private_message_plugin.cpp.

◆ ~private_message_plugin()

golos::private_message::private_message_plugin::~private_message_plugin ( )
virtual

Definition at line 80 of file private_message_plugin.cpp.

Member Function Documentation

◆ plugin_initialize()

void golos::private_message::private_message_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 95 of file private_message_plugin.cpp.

◆ plugin_name()

std::string golos::private_message::private_message_plugin::plugin_name ( ) const
overridevirtual

Reimplemented from golos::application::plugin.

Definition at line 83 of file private_message_plugin.cpp.

◆ plugin_set_program_options()

void golos::private_message::private_message_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 87 of file private_message_plugin.cpp.

◆ plugin_startup()

void golos::private_message::private_message_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 134 of file private_message_plugin.cpp.

◆ tracked_accounts()

flat_map< string, string > golos::private_message::private_message_plugin::tracked_accounts ( ) const

Definition at line 137 of file private_message_plugin.cpp.

Friends And Related Function Documentation

◆ detail::private_message_plugin_impl

map start_range to end_range

Definition at line 186 of file private_message_plugin.hpp.

Member Data Documentation

◆ my

std::unique_ptr<detail::private_message_plugin_impl> golos::private_message::private_message_plugin::my

Definition at line 188 of file private_message_plugin.hpp.


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