PTLib  Version 2.10.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PPluginManager Class Reference

#include <pluginmgr.h>

Inheritance diagram for PPluginManager:
PObject

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

PBoolean LoadPlugin (const PString &fileName)
void LoadPluginDirectory (const PDirectory &dir)
void OnShutdown ()
PStringArray GetPluginTypes () const
PStringArray GetPluginsProviding (const PString &serviceType) const
PPluginServiceDescriptorGetServiceDescriptor (const PString &serviceName, const PString &serviceType) const
PObjectCreatePluginsDevice (const PString &serviceName, const PString &serviceType, int userData=0) const
PObjectCreatePluginsDeviceByName (const PString &deviceName, const PString &serviceType, int userData=0, const PString &serviceName=PString::Empty()) const
PStringArray GetPluginsDeviceNames (const PString &serviceName, const PString &serviceType, int userData=0) const
PBoolean GetPluginsDeviceCapabilities (const PString &serviceType, const PString &serviceName, const PString &deviceName, void *capabilities) const
PBoolean RegisterService (const PString &serviceName, const PString &serviceType, PPluginServiceDescriptor *descriptor)
void AddNotifier (const PNotifier &filterFunction, PBoolean existing=false)
 Add a notifier to the plugin manager.
void RemoveNotifier (const PNotifier &filterFunction)
- Public Member Functions inherited from PObject
virtual ~PObject ()
virtual PObjectClone () const
 Create a copy of the class on the heap.
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class.
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance.
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.
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank.
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects.
bool operator== (const PObject &obj) const
 Compare the two objects.
bool operator!= (const PObject &obj) const
 Compare the two objects.
bool operator< (const PObject &obj) const
 Compare the two objects.
bool operator> (const PObject &obj) const
 Compare the two objects.
bool operator<= (const PObject &obj) const
 Compare the two objects.
bool operator>= (const PObject &obj) const
 Compare the two objects.
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream.
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream.

Static Public Member Functions

static bool AddPluginDirs (const PString &dirs)
static PStringArray GetPluginDirs ()
static PPluginManagerGetPluginManager ()
- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string.
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()

Protected Member Functions

void LoadPluginDirectory (const PDirectory &directory, const PStringList &suffixes)
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.

Protected Attributes

PMutex m_pluginsMutex
PArray< PDynaLinkm_plugins
PMutex m_servicesMutex
PArray< PPluginServicem_services
PMutex m_notifiersMutex
PList< PNotifierm_notifiers

Member Enumeration Documentation

Enumerator:
LoadingPlugIn 
UnloadingPlugIn 

Member Function Documentation

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));

static bool PPluginManager::AddPluginDirs ( const PString dirs)
static
void PPluginManager::CallNotifier ( PDynaLink dll,
NotificationCode  code 
)
protected
PObject* PPluginManager::CreatePluginsDevice ( const PString serviceName,
const PString serviceType,
int  userData = 0 
) const
PObject* PPluginManager::CreatePluginsDeviceByName ( const PString deviceName,
const PString serviceType,
int  userData = 0,
const PString serviceName = PString::Empty() 
) const
static PStringArray PPluginManager::GetPluginDirs ( )
static
static PPluginManager& PPluginManager::GetPluginManager ( )
static
PBoolean PPluginManager::GetPluginsDeviceCapabilities ( const PString serviceType,
const PString serviceName,
const PString deviceName,
void *  capabilities 
) const
PStringArray PPluginManager::GetPluginsDeviceNames ( const PString serviceName,
const PString serviceType,
int  userData = 0 
) const
PStringArray PPluginManager::GetPluginsProviding ( const PString serviceType) const
PStringArray PPluginManager::GetPluginTypes ( ) const
PPluginServiceDescriptor* PPluginManager::GetServiceDescriptor ( const PString serviceName,
const PString serviceType 
) const
PBoolean PPluginManager::LoadPlugin ( const PString fileName)
void PPluginManager::LoadPluginDirectory ( const PDirectory dir)
void PPluginManager::LoadPluginDirectory ( const PDirectory directory,
const PStringList suffixes 
)
protected
void PPluginManager::OnShutdown ( )
PBoolean PPluginManager::RegisterService ( const PString serviceName,
const PString serviceType,
PPluginServiceDescriptor descriptor 
)
void PPluginManager::RemoveNotifier ( const PNotifier filterFunction)

Member Data Documentation

PList<PNotifier> PPluginManager::m_notifiers
protected
PMutex PPluginManager::m_notifiersMutex
protected
PArray<PDynaLink> PPluginManager::m_plugins
protected
PMutex PPluginManager::m_pluginsMutex
protected
PArray<PPluginService> PPluginManager::m_services
protected
PMutex PPluginManager::m_servicesMutex
protected

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