---

Plugin Class Reference

#include <plugin.h>

Inheritance diagram for Plugin:

List of all members.

Public Types
enum	pa_e {   PA_BEFORE_PARAM = 2 ^ 0, PA_INIT = 2 ^ 1, PA_BEFORE_FILTER = 2 ^ 2, PA_FILTER = 2 ^ 3,   PA_AFTER_FILTER = 2 ^ 4, PA_BEFORE_ANALYSE = 2 ^ 5, PA_ANALYSE = 2 ^ 6, PA_AFTER_ANALYSE = 2 ^ 7,   PA_FREE = 2 ^ 8, PA_ADDRFILTER = 2 ^ 9 }
enum	ps_e { PS_CONTINUE, PS_STOP, PS_DISABLE, PS_ENABLE }
Public Methods
virtual int	pa (void)
virtual void	setPointer (std::list< Filter * > *f, std::list< AddrFilter * > *d, std::list< Analyse * > *a, std::list< Report * > *r, std::list< Plugin * > *p)
virtual void	beforeParam (void)
virtual ps_e	init (void)
virtual ps_e	beforeFilter (Filter *fp)
virtual ps_e	filter (void)
virtual ps_e	afterFilter (Filter *fp)
virtual ps_e	beforeAnalyse (Analyse *ap)
virtual ps_e	analyse (void)
virtual ps_e	afterAnalyse (Analyse *ap)
virtual ps_e	free (void)
virtual bool	addrFilter (std::string &addr)
virtual	~Plugin ()
Protected Attributes
maps_t	maps

---

Detailed Description

The abstract Plugin class.

Author:

Tobias Erbsland

---

Member Enumeration Documentation

enum Plugin::pa_e

Enumeration values: PA_BEFORE_PARAM  PA_INIT  PA_BEFORE_FILTER  PA_FILTER  PA_AFTER_FILTER  PA_BEFORE_ANALYSE  PA_ANALYSE  PA_AFTER_ANALYSE  PA_FREE  PA_ADDRFILTER

enum Plugin::ps_e

Enumeration values: PS_CONTINUE  PS_STOP  PS_DISABLE  PS_ENABLE

---

Constructor & Destructor Documentation

Plugin::~Plugin (    )  [virtual]

The virtual deconstructor.

---

Member Function Documentation

virtual bool Plugin::addrFilter (  std::string &    addr )  [inline, virtual]

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

virtual ps_e Plugin::afterAnalyse (  Analyse *    ap )  [inline, virtual]

This function is called after every analysis.

virtual ps_e Plugin::afterFilter (  Filter *    fp )  [inline, virtual]

This function is called after the current selected filter is done.

virtual ps_e Plugin::analyse (  void    )  [inline, virtual]

Make sure that your plugin is the _only one_ use this function. A call should execute all selected analysis. Reimplemented in analysePlugin.

virtual ps_e Plugin::beforeAnalyse (  Analyse *    ap )  [inline, virtual]

This function is called before every analysis.

virtual ps_e Plugin::beforeFilter (  Filter *    fp )  [inline, virtual]

This function is called before the current selected filter is running.

virtual void Plugin::beforeParam (  void    )  [inline, 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 in analysePlugin, filterPlugin, and reportPlugin.

virtual ps_e Plugin::filter (  void    )  [inline, 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 in filterPlugin.

virtual ps_e Plugin::free (  void    )  [inline, virtual]

Before everything is done, this function is called to clean perhaps someting. Reimplemented in reportPlugin.

virtual ps_e Plugin::init (  void    )  [inline, virtual]

After reading all parameters, this function is called. Reimplemented in analysePlugin, filterPlugin, and reportPlugin.

virtual int Plugin::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 in analysePlugin, filterPlugin, and reportPlugin.

void Plugin::setPointer (  std::list< Filter * > *    f, std::list< AddrFilter * > *    d, std::list< Analyse * > *    a, std::list< Report * > *    r, std::list< Plugin * > *    p )  [virtual]

After adding the new plugin to the plugin list, this function is called to set all pointers to every list. So every plugin object can access all other objects in the system.

---

Member Data Documentation

maps_t Plugin::maps [protected]

---

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

• plugin.h
• plugin.cpp

---