drogon::plugin::GlobalFilters Class Reference

This plugin is used to add global filters to all HTTP requests. The json configuration is as follows: More...

#include <drogon/plugins/GlobalFilters.h>

Inheritance diagram for drogon::plugin::GlobalFilters:

Collaboration diagram for drogon::plugin::GlobalFilters:

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

Additional Inherited Members
Static Public Member Functions inherited from drogon::DrObject< GlobalFilters >
static const std::string &	classTypeName ()

Detailed Description

This plugin is used to add global filters to all HTTP requests. The json configuration is as follows:

  {
       "name": "drogon::plugin::GlobalFilters",
       "dependencies": [],
       "config": {
           // filters: the list of global filter names.
           "filters": [
               "FilterName1", "FilterName2",...
           ],
           // exempt: exempt must be a string or string array, regular
expressions for
           // URLs that don't have to be filtered.
           "exempt": [
               "^/static/.*\\.css", "^/images/.*",...
           ]
       }
  }

Member Function Documentation

initAndStart()

void drogon::plugin::GlobalFilters::initAndStart ( const Json::Value & config )

overridevirtual

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

Implements drogon::PluginBase.

shutdown()

void drogon::plugin::GlobalFilters::shutdown ( )

overridevirtual

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

Implements drogon::PluginBase.

---

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

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