plugins::Plugin Class Reference

Plugin base class for all voiphoney plugins. More...

#include <Plugin.h>

Inheritance diagram for plugins::Plugin:

Inheritance graph
[legend]
Collaboration diagram for plugins::Plugin:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Plugin ()
 Plugin default constructor.
virtual ~Plugin ()
 Plugin default destructor.
void SetActive (bool option)
 Defines if plugin is active or not.
void SetDebugger (Debug *dbg)
 Set Plugin Debugger.

Protected Attributes

const char * pluginfile
 String contaning plugin configuration file path.
string pluginName
 String containing plugin name.
string pluginVersion
 String contaning plugin version.
bool pluginActive
 Defines if plugin is active or not.
Debugdbg
 Our plugin Debug instance.


Detailed Description

Plugin base class for all voiphoney plugins.

Plugin class defines an interface for connecting to third party VoIP systems and honeypots, all voiphoney plugins inherit Plugin base class properties

Definition at line 32 of file Plugin.h.


Constructor & Destructor Documentation

plugins::Plugin::Plugin (  ) 

Plugin default constructor.

Definition at line 13 of file Plugin.cc.

References pluginName, and pluginVersion.

plugins::Plugin::~Plugin (  )  [virtual]

Plugin default destructor.

Definition at line 36 of file Plugin.cc.


Member Function Documentation

void plugins::Plugin::SetActive ( bool  option  ) 

Defines if plugin is active or not.

Parameters:
option active or deactive this plugin

Definition at line 24 of file Plugin.cc.

References dbg, pluginActive, pluginName, and pluginVersion.

Referenced by main().

void plugins::Plugin::SetDebugger ( Debug dbg  ) 

Set Plugin Debugger.

Parameters:
dbg Debug instance for Plugin class

Referenced by main().


Member Data Documentation

Our plugin Debug instance.

Definition at line 60 of file Plugin.h.

Referenced by plugins::AsteriskPlugin::getAstPID(), plugins::AsteriskPlugin::LoadConf(), and SetActive().

Defines if plugin is active or not.

Definition at line 58 of file Plugin.h.

Referenced by SetActive().

const char* plugins::Plugin::pluginfile [protected]

String contaning plugin configuration file path.

Definition at line 52 of file Plugin.h.

string plugins::Plugin::pluginName [protected]

String containing plugin name.

Definition at line 54 of file Plugin.h.

Referenced by plugins::AsteriskPlugin::AsteriskPlugin(), Plugin(), and SetActive().

string plugins::Plugin::pluginVersion [protected]

String contaning plugin version.

Definition at line 56 of file Plugin.h.

Referenced by plugins::AsteriskPlugin::AsteriskPlugin(), Plugin(), and SetActive().


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

VoipHoney is proudly sponsored by OpenVoIP

This documentation has been generated using doxygen 1.5.8