drogon::PluginBase Class Reference

The abstract base class for plugins. More...

#include <drogon/plugins/Plugin.h>

Inheritance diagram for drogon::PluginBase:

Collaboration diagram for drogon::PluginBase:

Public Member Functions
void	initialize ()
	This method must be called by drogon.
virtual void	initAndStart (const Json::Value &config)=0
virtual void	shutdown ()=0
Public Member Functions inherited from drogon::DrObjectBase
virtual const std::string &	className () const
	Get the class name.
virtual bool	isClass (const std::string &class_name) const
	Return true if the class name is 'class_name'.

Friends
class	PluginsManager

Detailed Description

The abstract base class for plugins.

Member Function Documentation

initAndStart()

virtual void drogon::PluginBase::initAndStart ( const Json::Value & config )

pure virtual

This method must be called by drogon to initialize and start the plugin. It must be implemented by the user.

Implemented in drogon::plugin::AccessLogger, drogon::plugin::GlobalFilters, drogon::plugin::Hodor, drogon::plugin::PromExporter, drogon::plugin::RealIpResolver, drogon::plugin::Redirector, drogon::plugin::SecureSSLRedirector, and drogon::plugin::SlashRemover.

shutdown()

virtual void drogon::PluginBase::shutdown ( )

pure virtual

This method must be called by drogon to shutdown the plugin. It must be implemented by the user.

Implemented in drogon::plugin::AccessLogger, drogon::plugin::GlobalFilters, drogon::plugin::Hodor, drogon::plugin::PromExporter, drogon::plugin::RealIpResolver, drogon::plugin::Redirector, drogon::plugin::SecureSSLRedirector, and drogon::plugin::SlashRemover.

---

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

• lib/inc/drogon/plugins/Plugin.h