PluginHooks.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _PLUGINHOOKS_H_
#define _PLUGINHOOKS_H_

// SYSTEM INCLUDES
#include "utl/UtlSortedList.h"
#include "utl/UtlSortedListIterator.h"

// APPLICATION INCLUDES
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class Plugin;
class PluginIterator;
class OsConfigDb;

class PluginHooks
{
public:

   PluginHooks(const char* hookFactoryName, 
               const char* hookPrefix       
               );

   ~PluginHooks();

   void readConfig( OsConfigDb& configDb );
   size_t entries() const;

protected:
   friend class PluginIterator;

   UtlString      mFactory;         
   UtlString      mPrefix;          
   UtlSortedList  mConfiguredHooks; 
};

class PluginIterator
{
public:

   PluginIterator(const PluginHooks& pluginHooks);

   ~PluginIterator();

   Plugin* next(UtlString* name = NULL 
               );
private:
   UtlSortedListIterator mConfiguredHooksIterator;

};

#endif // _PLUGINHOOKS_H_