NAWA 0.9
Web Application Framework for C++
nawa::BlockFilter Class Reference

#include <nawa/filter/AccessFilter/ext/BlockFilter.h>

Inherits nawa::AccessFilter.

Public Member Functions

 ~BlockFilter () override
 
 BlockFilter ()
 
 BlockFilter (BlockFilter const &other)
 
BlockFilteroperator= (const BlockFilter &other)
 
 BlockFilter (BlockFilter &&other) noexcept
 
BlockFilteroperator= (BlockFilter &&other) noexcept
 
unsigned int & status () noexcept
 
unsigned int status () const noexcept
 
BlockFilterstatus (unsigned int value) noexcept
 
- Public Member Functions inherited from nawa::AccessFilter
virtual ~AccessFilter ()
 
 AccessFilter ()
 
 AccessFilter (AccessFilter const &other)
 
AccessFilteroperator= (const AccessFilter &other)
 
 AccessFilter (AccessFilter &&other) noexcept
 
AccessFilteroperator= (AccessFilter &&other) noexcept
 
bool & invert () noexcept
 
bool invert () const noexcept
 
AccessFilterinvert (bool value) noexcept
 
std::vector< std::vector< std::string > > & pathFilter () noexcept
 
std::vector< std::vector< std::string > > const & pathFilter () const noexcept
 
AccessFilterpathFilter (std::vector< std::vector< std::string > > value) noexcept
 
bool & invertPathFilter () noexcept
 
bool invertPathFilter () const noexcept
 
AccessFilterinvertPathFilter (bool value) noexcept
 
std::vector< std::string > & extensionFilter () noexcept
 
std::vector< std::string > const & extensionFilter () const noexcept
 
AccessFilterextensionFilter (std::vector< std::string > value) noexcept
 
bool & invertExtensionFilter () noexcept
 
bool invertExtensionFilter () const noexcept
 
AccessFilterinvertExtensionFilter (bool value) noexcept
 
bool & regexFilterEnabled () noexcept
 
bool regexFilterEnabled () const noexcept
 
AccessFilterregexFilterEnabled (bool value) noexcept
 
std::regex & regexFilter () noexcept
 
std::regex const & regexFilter () const noexcept
 
AccessFilterregexFilter (std::regex value) noexcept
 
std::string & response () noexcept
 
std::string const & response () const noexcept
 
AccessFilterresponse (std::string value) noexcept
 
bool matches (std::vector< std::string > const &requestPath) const
 

Detailed Description

Defines a request blocking filter.

Definition at line 33 of file BlockFilter.h.

Constructor & Destructor Documentation

◆ ~BlockFilter()

nawa::BlockFilter::~BlockFilter ( )
override

◆ BlockFilter() [1/3]

nawa::BlockFilter::BlockFilter ( )

◆ BlockFilter() [2/3]

nawa::BlockFilter::BlockFilter ( BlockFilter const &  other)

◆ BlockFilter() [3/3]

nawa::BlockFilter::BlockFilter ( BlockFilter &&  other)
noexcept

Member Function Documentation

◆ operator=() [1/2]

BlockFilter & nawa::BlockFilter::operator= ( const BlockFilter other)

◆ operator=() [2/2]

BlockFilter & nawa::BlockFilter::operator= ( BlockFilter &&  other)
noexcept

◆ status() [1/3]

unsigned int & nawa::BlockFilter::status ( )
noexcept

The HTTP status that will be sent to the client if the request is blocked.

Returns
Reference to element.

◆ status() [2/3]

unsigned int nawa::BlockFilter::status ( ) const
noexcept

◆ status() [3/3]

BlockFilter & nawa::BlockFilter::status ( unsigned int  value)
noexcept

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