sysio::template_plugin Class Reference

#include <template_plugin.hpp>

Inheritance diagram for sysio::template_plugin:

Collaboration diagram for sysio::template_plugin:

Public Member Functions
	template_plugin ()
virtual	~template_plugin ()
virtual void	set_program_options (options_description &, options_description &cfg) override
void	plugin_initialize (const variables_map &options)
void	plugin_startup ()
void	plugin_shutdown ()
Public Member Functions inherited from appbase::plugin< template_plugin >
	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 ()

Additional Inherited Members
Public Types inherited from appbase::abstract_plugin
enum	state { registered , initialized , started , stopped }
Protected Member Functions inherited from appbase::plugin< template_plugin >
	plugin (const string &name)

Detailed Description

This is a template plugin, intended to serve as a starting point for making new plugins

Definition at line 11 of file template_plugin.hpp.

Constructor & Destructor Documentation

template_plugin()

sysio::template_plugin::template_plugin

(

)

Definition at line 10 of file template_plugin.cpp.

:my(new template_plugin_impl()){}

~template_plugin()

sysio::template_plugin::~template_plugin ( )

virtual

Definition at line 11 of file template_plugin.cpp.

{}

Member Function Documentation

plugin_initialize()

void sysio::template_plugin::plugin_initialize

(

const variables_map &

options

)

Definition at line 20 of file template_plugin.cpp.

                                                                    {
   try {
      if( options.count( "option-name" )) {
         // Handle the option
      }
   }
   FC_LOG_AND_RETHROW()
}

plugin_shutdown()

void sysio::template_plugin::plugin_shutdown

(

)

Definition at line 33 of file template_plugin.cpp.

                                      {
   // OK, that's enough magic
}

plugin_startup()

void sysio::template_plugin::plugin_startup

(

)

Definition at line 29 of file template_plugin.cpp.

                                     {
   // Make the magic happen
}

set_program_options()

void sysio::template_plugin::set_program_options ( options_description & , options_description & cfg )

overridevirtual

Implements appbase::abstract_plugin.

Definition at line 13 of file template_plugin.cpp.

                                                                                        {
   cfg.add_options()
         ("option-name", bpo::value<string>()->default_value("default value"),
          "Option Description")
         ;
}

---

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

• plugins/template_plugin/include/sysio/template_plugin/template_plugin.hpp
• plugins/template_plugin/template_plugin.cpp