appbase::plugin< Impl > Class Template Reference

#include <application.hpp>

Inheritance diagram for appbase::plugin< Impl >:

Collaboration diagram for appbase::plugin< Impl >:

Public Member Functions
	plugin ()
virtual	~plugin ()
virtual state	get_state () const override
virtual const std::string &	name () const override
virtual void	register_dependencies ()
virtual void	initialize (const variables_map &options) override
virtual void	handle_sighup () override
virtual void	startup () override
virtual void	shutdown () override
Public Member Functions inherited from appbase::abstract_plugin
virtual	~abstract_plugin ()
virtual void	set_program_options (options_description &cli, options_description &cfg)=0

Protected Member Functions
	plugin (const string &name)

Additional Inherited Members
Public Types inherited from appbase::abstract_plugin
enum	state { registered , initialized , started , stopped }

Detailed Description

template<typename Impl>
class appbase::plugin< Impl >

Definition at line 48 of file plugin.hpp.

Constructor & Destructor Documentation

plugin() [1/2]

template<typename Impl >

appbase::plugin< Impl >::plugin ( )

inline

Definition at line 284 of file application.hpp.

:_name(boost::core::demangle(typeid(Impl).name())){}

~plugin()

template<typename Impl >

virtual appbase::plugin< Impl >::~plugin ( )

inlinevirtual

Definition at line 285 of file application.hpp.

{}

plugin() [2/2]

template<typename Impl >

appbase::plugin< Impl >::plugin ( const string & name )

inlineprotected

Definition at line 327 of file application.hpp.

: _name(name){}

Member Function Documentation

get_state()

template<typename Impl >

virtual state appbase::plugin< Impl >::get_state ( ) const

inlineoverridevirtual

Implements appbase::abstract_plugin.

Definition at line 287 of file application.hpp.

{ return _state; }

Here is the caller graph for this function:

handle_sighup()

template<typename Impl >

virtual void appbase::plugin< Impl >::handle_sighup ( )

inlineoverridevirtual

Implements appbase::abstract_plugin.

Reimplemented in sysio::chain_plugin, sysio::http_plugin, sysio::net_plugin, sysio::producer_plugin, sysio::trace_api_plugin, and sysio::trace_api_rpc_plugin.

Definition at line 305 of file application.hpp.

                                               {
         }

initialize()

template<typename Impl >

virtual void appbase::plugin< Impl >::initialize ( const variables_map & options )

inlineoverridevirtual

if initial state was not registered, final state cannot be initialized

Implements appbase::abstract_plugin.

Definition at line 294 of file application.hpp.

                                                                        {
            if(_state == registered) {
               _state = initialized;
               static_cast<Impl*>(this)->plugin_requires([&](auto& plug){ plug.initialize(options); });
               static_cast<Impl*>(this)->plugin_initialize(options);
               //ilog( "initializing plugin ${name}", ("name",name()) );
               app().plugin_initialized(*this);
            }
            assert(_state == initialized); 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

name()

template<typename Impl >

virtual const std::string & appbase::plugin< Impl >::name ( ) const

inlineoverridevirtual

Implements appbase::abstract_plugin.

Definition at line 288 of file application.hpp.

{ return _name; }

register_dependencies()

template<typename Impl >

virtual void appbase::plugin< Impl >::register_dependencies ( )

inlinevirtual

Definition at line 290 of file application.hpp.

                                              {
            static_cast<Impl*>(this)->plugin_requires([&](auto& plug){});
         }

shutdown()

template<typename Impl >

virtual void appbase::plugin< Impl >::shutdown ( )

inlineoverridevirtual

Implements appbase::abstract_plugin.

Definition at line 318 of file application.hpp.

                                          {
            if(_state == started) {
               _state = stopped;
               //ilog( "shutting down plugin ${name}", ("name",name()) );
               static_cast<Impl*>(this)->plugin_shutdown();
            }
         }

startup()

template<typename Impl >

virtual void appbase::plugin< Impl >::startup ( )

inlineoverridevirtual

Implements appbase::abstract_plugin.

Definition at line 308 of file application.hpp.

                                         {
            if(_state == initialized) {
               _state = started;
               static_cast<Impl*>(this)->plugin_requires([&](auto& plug){ plug.startup(); });
               static_cast<Impl*>(this)->plugin_startup();
               app().plugin_started(*this);
            }
            assert(_state == started); // if initial state was not initialized, final state cannot be started
         }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• libraries/appbase/include/appbase/application.hpp
• libraries/appbase/include/appbase/plugin.hpp