---

filterPlugin Class Reference

Filter selection and adressfilter plugin. More...

#include <filterplugin.h>

Inheritance diagram for filterPlugin:

List of all members.

Public Methods
	filterPlugin ()
virtual const char *	Prefix (void) const
virtual const char *	Name (void) const
virtual const char *	Version (void) const
virtual const char *	Author (void) const
virtual const char *	Help (void) const
virtual int	pa (void)
virtual void	beforeParam (void)
virtual ps_e	init (void)
virtual ps_e	filter (void)
virtual bool	addrFilter (std::string &addr)
virtual	~filterPlugin ()
Private Attributes
const char *const	strPrefix
const char *const	strName
const char *const	strVersion
const char *const	strAuthor
const char *const	strHelp
bool	disable_addrfilter

---

Detailed Description

Filter selection and adressfilter plugin.

This plugin controls the selection of the Filter. And execute all adressfilters.

Author:

Tobias Erbsland

---

Constructor & Destructor Documentation

filterPlugin::filterPlugin (    )

filterPlugin::~filterPlugin (    )  [virtual]

---

Member Function Documentation

bool filterPlugin::addrFilter (  std::string &    addr )  [virtual]

This function is called from a filter object for every adress. It should call all necessary addrfilters and return the result summary. Reimplemented from Plugin.

virtual const char* filterPlugin::Author (  void    )  const [inline, virtual]

Name of authors of the Object with Email in format "Firstname Lastname <email>" up to 40 chars. Reimplemented from Parameter.

void filterPlugin::beforeParam (  void    )  [virtual]

This function is executed if the Flag PA_BEFORE_PARAM set before any Parameters are read from the plugin object. Place here code to generate generic parameters, based on other objects in the system. Reimplemented from Plugin.

filterPlugin::ps_e filterPlugin::filter (  void    )  [virtual]

If you use this function, make sure that your plugin is the _only one_ who use this. A call of this function should run the filter. Reimplemented from Plugin.

virtual const char* filterPlugin::Help (  void    )  const [inline, virtual]

A short helptext, or description to this object. Reimplemented from Parameter.

filterPlugin::ps_e filterPlugin::init (  void    )  [virtual]

After reading all parameters, this function is called. Reimplemented from Plugin.

virtual const char* filterPlugin::Name (  void    )  const [inline, virtual]

Select a short Name for the parameter Object. Reimplemented from Parameter.

virtual int filterPlugin::pa (  void    )  [inline, virtual]

This function is tested before every action. You can return a set of function flags to execute this functions of your plugin object. Reimplemented from Plugin.

virtual const char* filterPlugin::Prefix (  void    )  const [inline, virtual]

This function returns a unique object prefix. Use only lowercase letters (a-z) and keep this name short as possible. Implements Parameter.

virtual const char* filterPlugin::Version (  void    )  const [inline, virtual]

Version up to 8 chars in the format V-.- Reimplemented from Parameter.

---

Member Data Documentation

bool filterPlugin::disable_addrfilter [private]

const char* const filterPlugin::strAuthor [private]

const char* const filterPlugin::strHelp [private]

const char* const filterPlugin::strName [private]

const char* const filterPlugin::strPrefix [private]

const char* const filterPlugin::strVersion [private]

---

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

• filterplugin.h
• filterplugin.cpp

---