Plugin Class Reference

Inheritance diagram for Plugin:

List of all members.

Public Member Functions
virtual void *	getDirectMethod (char *name)
virtual const char *	getName (char *buffer, u_long len)
virtual int	getVersion ()
virtual int	load (string &file, Server *server, XmlParser *languageFile)
	Plugin ()
virtual int	postLoad (Server *server, XmlParser *languageFile)
virtual int	preLoad (string &file, Server *server, XmlParser *languageFile, bool global)
virtual int	unLoad (XmlParser *languageFile)
virtual	~Plugin ()
Static Public Member Functions
int	createVersion (int v=1, int x=0, int y=0, int z=0)
int	getVersionMinor (int version)
int	getVersionNumber (int version)
int	getVersionRevision (int version)
int	getVersionStatus (int version)
Protected Attributes
DynamicLibrary	hinstLib
Private Attributes
int	version

---

Constructor & Destructor Documentation

Plugin::Plugin (   )

Construct a plugin object.

Plugin::~Plugin (   )  [virtual]

Destroy the object.

---

Member Function Documentation

int Plugin::createVersion (  int  v = 1, int  x = 0, int  y = 0, int  z = 0 )  [static]

void * Plugin::getDirectMethod (  char *  name  )  [virtual]

Get directly access to a method. Parameters: name  The method name.

const char * Plugin::getName (  char *  buffer, u_long  len )  [virtual]

Get the plugin name. Parameters: buffer  The buffer where write the plugin name. len  The buffer length in bytes.

int Plugin::getVersion (   )  [virtual]

Get the version number for this plugin.

int Plugin::getVersionMinor (  int  version  )  [static]

int Plugin::getVersionNumber (  int  version  )  [static]

int Plugin::getVersionRevision (  int  version  )  [static]

int Plugin::getVersionStatus (  int  version  )  [static]

int Plugin::load (  string &  file, Server *  server, XmlParser *  languageFile )  [virtual]

Load the plugin. Parameters: file  The filename to load. server  The server instance to use. languageFile  The language file to use to retrieve warnings/errors messages.

int Plugin::postLoad (  Server *  server, XmlParser *  languageFile )  [virtual]

Post load initialization. This is called once all the plugins are loaded. Parameters: file  The filename to load. server  The server instance to use. languageFile  The language file to use to retrieve warnings/errors messages.

int Plugin::preLoad (  string &  file, Server *  server, XmlParser *  languageFile, bool  global )  [virtual]

Preload the plugin. This function doesn't ensure all other plugins are yet loaded. Parameters: file  The filename to load. server  The server instance to use. languageFile  The language file to use to retrieve warnings/errors messages. global  Load the shared library globally.

int Plugin::unLoad (  XmlParser *  languageFile  )  [virtual]

Unload the plugin. Parameters: languageFile  The language file to use to retrieve warnings/errors messages.

---

Member Data Documentation

DynamicLibrary Plugin::hinstLib [protected]

Reimplemented in DynamicHttpCommand.

int Plugin::version [private]

A number in the form v.x.y.z where: v is the version major number. x is the version minor number. y is the version revision number. z is the version status number.

---