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 ()
	Constructor registers the plug-in to appear in getPlugins().
virtual Options *	getOptions ()
	Configuration options for the plugin.
virtual void	earlyInitialize (Target &)=0
	Initialize Plugin functionality on a Target, called before initializing the 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.
static void	earlyInitAll (Target &)
	Call earlyInitialize() on all registered plugins.
static void	initializeAll (Target &)
	Call initialize() on all registered plugins.
static void	addOptions (Options &opts)
	For each registered plugin, add plugin.getOptions() to opts.
Classes
class	Target
	Base interface for targets that can receive plug-ins. More...

---

Detailed Description

Plug-in base class.

Definition at line 36 of file Plugin.h.

---

Constructor & Destructor Documentation

qpid::Plugin::Plugin

(

)

Constructor 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 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, called before initializing the 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.

Called after initializing the 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.

static void qpid::Plugin::addOptions

(

Options &

opts

)

[static]

For each registered plugin, add plugin.getOptions() to opts.

---

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

• /home/nsantos/projects/mrg-team/testing/magnum/f10/qpidc/qpid/cpp/src/qpid/Plugin.h