qpid::Plugin Class Reference

Plug-in base class. More...

#include <Plugin.h>

List of all members.

Public Types

typedef std::vector< Plugin * > Plugins

Public Member Functions

 Plugin ()
 Construct registers the plug-in to appear in getPlugins().
virtual OptionsgetOptions ()
 Configuration options for the plugin.
virtual void earlyInitialize (Target &)=0
 Initialize Plugin functionality on a Target.
virtual void initialize (Target &)=0
 Initialize Plugin functionality on a Target.

Static Public Member Functions

static const Plugins & getPlugins ()
 List of registered Plugin objects.

Classes

struct  Target
 Base interface for targets that receive plug-ins. More...


Detailed Description

Plug-in base class.

Constructor & Destructor Documentation

qpid::Plugin::Plugin (  ) 

Construct registers the plug-in to appear in getPlugins().

A concrete Plugin is instantiated as a global or static member variable in a library so it is registered during static initialization when the library is loaded.


Member Function Documentation

virtual Options* qpid::Plugin::getOptions (  )  [virtual]

Configuration options for the plugin.

Then will be updated during option parsing by the host program.

Returns:
An options group or 0 for no options. Default returns 0. Plugin retains ownership of return value.

virtual void qpid::Plugin::earlyInitialize ( Target  )  [pure virtual]

Initialize Plugin functionality on a Target.

Plugins should ignore targets they don't recognize.

Called before the target itself is initialized.

virtual void qpid::Plugin::initialize ( Target  )  [pure virtual]

Initialize Plugin functionality on a Target.

Plugins should ignore targets they don't recognize.

Called after the target is fully initialized.

static const Plugins& qpid::Plugin::getPlugins (  )  [static]

List of registered Plugin objects.

Caller must not delete plugin pointers.


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

Generated on Thu May 15 22:22:22 2008 for Qpid by  doxygen 1.5.5