#include <pluginmgr.h>

Inheritance diagram for PPluginManager:

Collaboration diagram for PPluginManager:

Public Types
enum	NotificationCode { LoadingPlugIn, UnloadingPlugIn }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
void	AddDirectory (const PDirectory &dir)

void	SetDirectories (const PString &dirs)

void	SetDirectories (const PStringArray &dirs)

void	LoadDirectories ()

void	LoadDirectory (const PDirectory &dir)

PBoolean	LoadPlugin (const PString &fileName)

void	OnShutdown ()

PStringArray	GetServiceTypes () const

const PPluginServiceDescriptor *	GetServiceDescriptor (const PString &serviceName, const PString &serviceType) const

PStringArray	GetPluginsProviding (const PString &serviceType, bool friendlyNames) const

PObject *	CreatePlugin (const PString &serviceName, const PString &serviceType, P_INT_PTR userData=0) const

PStringArray	GetPluginDeviceNames (const PString &serviceName, const PString &serviceType, P_INT_PTR userData=0, const char const prioritisedDrivers=NULL) const

PBoolean	GetPluginsDeviceCapabilities (const PString &serviceType, const PString &serviceName, const PString &deviceName, void *capabilities) const

bool	RegisterService (const char *name)

void	AddNotifier (const PNotifier &filterFunction, PBoolean existing=false)
	Add a notifier to the plugin manager. More...

void	RemoveNotifier (const PNotifier &filterFunction)

P_DEPRECATED PObject *	CreatePluginsDevice (const PString &serviceName, const PString &serviceType, int userData=0) const

P_DEPRECATED PObject *	CreatePluginsDeviceByName (const PString &deviceName, const PString &serviceType, int userData=0, const PString &serviceName=PString::Empty()) const

Public Member Functions inherited from PObject
unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

void	SetTraceContextIdentifier (unsigned id)

void	GetTraceContextIdentifier (PObject &obj)

void	GetTraceContextIdentifier (PObject *obj)

void	SetTraceContextIdentifier (const PObject &obj)

void	SetTraceContextIdentifier (const PObject *obj)

virtual	~PObject ()

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...

PBoolean	IsClass (const char *cls) const

virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...

__inline const PObject *	PTraceObjectInstance () const

virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Static Public Member Functions
static PPluginManager &	GetPluginManager ()

static PStringArray	GetPluginsProviding (PPluginManager *pluginMgr, const PString &serviceType, bool friendlyNames)

template<class T >
static T *	CreatePluginAs (PPluginManager *pluginMgr, const PString &serviceName, const PString &serviceType, P_INT_PTR userData=0)

static PStringArray	GetPluginDeviceNames (PPluginManager pluginMgr, const PString &serviceName, const PString &serviceType, P_INT_PTR userData=0, const char const *prioritisedDrivers=NULL)

Static Public Member Functions inherited from PObject
static const char *	Class ()
	Get the name of the class as a C string. More...

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Types
typedef std::multimap < PCaselessString, const PPluginServiceDescriptor * >	ServiceMap

Protected Member Functions
	PPluginManager ()

void	CallNotifier (PDynaLink &dll, NotificationCode code)

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PList< PDirectory >	m_directories

PStringList	m_suffixes

PMutex	m_pluginsMutex

PArray< PDynaLink >	m_plugins

ServiceMap	m_services

PMutex	m_servicesMutex

PMutex	m_notifiersMutex

PList< PNotifier >	m_notifiers

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Member Typedef Documentation

typedef std::multimap<PCaselessString, const PPluginServiceDescriptor *> PPluginManager::ServiceMap

protected

Member Enumeration Documentation

enum PPluginManager::NotificationCode

Enumerator
LoadingPlugIn
UnloadingPlugIn

Constructor & Destructor Documentation

PPluginManager::PPluginManager ( )

protected

Member Function Documentation

void PPluginManager::AddDirectory ( const PDirectory & dir )

void PPluginManager::AddNotifier	(	const PNotifier &	filterFunction,
		PBoolean	existing = `false`
	)

Add a notifier to the plugin manager.

   The call back function is executed just after loading, or 
   just after unloading, a plugin. 

   To use define:
     PDECLARE_NOTIFIER(PDynaLink, YourClass, YourFunction);
   and
     void YourClass::YourFunction(PDynaLink & dll, INT code)
     {

code == 0 means loading code == 1 means unloading } and to connect to the plugin manager: PPluginManager & mgr = PPluginManager::GetPluginManager(); mgr->AddNotifier((PCREATE_NOTIFIER(YourFunction));

void PPluginManager::CallNotifier	(	PDynaLink &	dll,
		NotificationCode	code
	)

protected

PObject* PPluginManager::CreatePlugin	(	const PString &	serviceName,
		const PString &	serviceType,
		P_INT_PTR	userData = `0`
	)		const

Referenced by CreatePluginAs(), CreatePluginsDevice(), and CreatePluginsDeviceByName().

template<class T >

static T* PPluginManager::CreatePluginAs	(	PPluginManager *	pluginMgr,
		const PString &	serviceName,
		const PString &	serviceType,
		P_INT_PTR	userData = `0`
	)

inlinestatic

References CreatePlugin(), and GetPluginManager().

P_DEPRECATED PObject* PPluginManager::CreatePluginsDevice	(	const PString &	serviceName,
		const PString &	serviceType,
		int	userData = `0`
	)		const

inline

References CreatePlugin().

P_DEPRECATED PObject* PPluginManager::CreatePluginsDeviceByName	(	const PString &	deviceName,
		const PString &	serviceType,
		int	userData = `0`,
		const PString &	serviceName = `PString::Empty()`
	)		const

inline

References CreatePlugin(), and PString::IsEmpty().

static PStringArray PPluginManager::GetPluginDeviceNames	(	PPluginManager *	pluginMgr,
		const PString &	serviceName,
		const PString &	serviceType,
		P_INT_PTR	userData = `0`,
		const char const	prioritisedDrivers = `NULL`
	)

inlinestatic

References GetPluginManager().

PStringArray PPluginManager::GetPluginDeviceNames	(	const PString &	serviceName,
		const PString &	serviceType,
		P_INT_PTR	userData = `0`,
		const char const	prioritisedDrivers = `NULL`
	)		const

static PPluginManager& PPluginManager::GetPluginManager ( )

static

Referenced by CreatePluginAs(), GetPluginDeviceNames(), and GetPluginsProviding().

PBoolean PPluginManager::GetPluginsDeviceCapabilities	(	const PString &	serviceType,
		const PString &	serviceName,
		const PString &	deviceName,
		void *	capabilities
	)		const

static PStringArray PPluginManager::GetPluginsProviding	(	PPluginManager *	pluginMgr,
		const PString &	serviceType,
		bool	friendlyNames
	)

inlinestatic

References GetPluginManager().

PStringArray PPluginManager::GetPluginsProviding	(	const PString &	serviceType,
		bool	friendlyNames
	)		const

const PPluginServiceDescriptor* PPluginManager::GetServiceDescriptor	(	const PString &	serviceName,
		const PString &	serviceType
	)		const

PStringArray PPluginManager::GetServiceTypes ( ) const

void PPluginManager::LoadDirectories ( )

void PPluginManager::LoadDirectory ( const PDirectory & dir )

PBoolean PPluginManager::LoadPlugin ( const PString & fileName )

void PPluginManager::OnShutdown ( )

bool PPluginManager::RegisterService ( const char * name )

void PPluginManager::RemoveNotifier ( const PNotifier & filterFunction )

void PPluginManager::SetDirectories ( const PString & dirs )

void PPluginManager::SetDirectories ( const PStringArray & dirs )

Member Data Documentation

PList<PDirectory> PPluginManager::m_directories

protected

PList<PNotifier> PPluginManager::m_notifiers

protected

PMutex PPluginManager::m_notifiersMutex

protected

PArray<PDynaLink> PPluginManager::m_plugins

protected

PMutex PPluginManager::m_pluginsMutex

protected

ServiceMap PPluginManager::m_services

protected

PMutex PPluginManager::m_servicesMutex

protected

PStringList PPluginManager::m_suffixes

protected

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

pluginmgr.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation