E-MailRelay
Public Member Functions | List of all members
GFilters::SimpleFilterBase Class Referenceabstract

A GSmtp::Filter base class for filters that run synchronously. More...

#include <gsimplefilterbase.h>

+ Inheritance diagram for GFilters::SimpleFilterBase:
+ Collaboration diagram for GFilters::SimpleFilterBase:

Public Member Functions

 SimpleFilterBase (GNet::EventState, Filter::Type, std::string_view id)
 Constructor. More...
 
virtual Result run (const GStore::MessageId &, bool &special_out, GStore::FileStore::State)=0
 Runs the filter synchronously and returns the result.
 
std::string prefix () const
 Returns a logging prefix derived from Filter::Type and filter id. More...
 
- Public Member Functions inherited from GSmtp::Filter
virtual ~Filter ()=default
 Destructor.
 
virtual std::string id () const =0
 Returns the id passed to the derived-class constructor. More...
 
virtual bool quiet () const =0
 Returns true if there is no need for logging.
 
virtual void start (const GStore::MessageId &)=0
 Starts the filter for the given message. More...
 
virtual G::Slot::Signal< int > & doneSignal () noexcept=0
 Returns a signal which is raised once start() has completed or failed. More...
 
virtual void cancel ()=0
 Aborts any incomplete filtering.
 
virtual Result result () const =0
 Returns the filter result, after the doneSignal() has been emitted.
 
virtual std::string response () const =0
 Returns a non-empty SMTP response string iff the filter failed, or an empty response if successful or abandoned.
 
virtual int responseCode () const =0
 An override for the SMTP response code for when the filter has failed. More...
 
virtual std::string reason () const =0
 Returns a non-empty reason string iff the filter failed, or an empty reason if successful or abandoned.
 
virtual bool special () const =0
 Returns true if the filter indicated special handling is required.
 
std::string str (Type type) const
 Returns a diagnostic string for logging, including the filter result. More...
 

Additional Inherited Members

- Public Types inherited from GSmtp::Filter
enum class  Result { ok = 0 , abandon = 1 , fail = 2 }
 
enum class  Type { server , client , routing }
 
- Static Public Member Functions inherited from GSmtp::Filter
static std::string_view strtype (Type type) noexcept
 Returns a type string for logging: "filter", "client-filter" or "routing-filter". More...
 

Detailed Description

A GSmtp::Filter base class for filters that run synchronously.

Concrete classes should implement run().

Definition at line 42 of file gsimplefilterbase.h.

Constructor & Destructor Documentation

◆ SimpleFilterBase()

GFilters::SimpleFilterBase::SimpleFilterBase ( GNet::EventState  es,
Filter::Type  filter_type,
std::string_view  id 
)

Constructor.

Definition at line 25 of file gsimplefilterbase.cpp.

Member Function Documentation

◆ prefix()

std::string GFilters::SimpleFilterBase::prefix ( ) const

Returns a logging prefix derived from Filter::Type and filter id.

Definition at line 95 of file gsimplefilterbase.cpp.


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