/usr/include/sipxtapi/utl/Plugin.h is in libsipxtapi-dev 3.3.0~test17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | //
// 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 _PLUGIN_H_
#define _PLUGIN_H_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlString.h"
class OsConfigDb;
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class Plugin;
/**
* A Plugin is a dynamically loaded object that is invoked by some component at some
* well defined time (it's an abstract class - how specific can the
* description be?).
*
* This class is the abstract base from which all plugins must inherit; it
* decouples the configuration of what plugins should be invoked and the
* configuration parameters specific to each plugin from the program that
* uses them.
*
* @htmlinclude PluginOverview.html
*
* All Plugin classes must implement three methods to configure the plugin
* into the component:
* - An extern "C" factory routine
* - The constructor for its class, which must ultimately derive from Plugin
* - The readConfig method used to pass configuration data to the plugin (this decouples plugin
* configuration from the component configuration).
*
* Each class derived from Plugin should also define the method(s) that
* the program should invoke on the plugin, and all those methods must be virtual.
*
* @see PluginHooks for details of how a plugin is configured into a program,
* and PluginIterator for how plugins are invoked by the calling component.
*
*/
class Plugin
{
public:
typedef Plugin* (*Factory)(const UtlString& pluginName);
/**<
* The Factory uses external C linkage to support dynamic loading of Plugin objects.
*
* In addition to the class derived from this base, a plugin must implement a
* Factory routine with extern "C" linkage so that the OsSharedLib mechanism
* can look it up in the dynamically loaded library (looking up C++ symbols
* is problematic because of name mangling). The Factory routine looks like:
* @code
* class ExamplePlugin;
*
* extern "C" ExamplePlugin* getExamplePlugin(const UtlString& name)
* {
* return new ExamplePlugin;
* }
*
* class ExamplePlugin : public Plugin
* {
* friend ExamplePlugin* getExamplePlugin(const UtlString& name);
* ...
* private:
* ExamplePlugin(const UtlString& name);
* }
* @endcode
*/
/// The plugin destructor must be virtual.
virtual ~Plugin()
{
};
/// Read (or re-read) whatever configuration the plugin requires.
virtual void readConfig( OsConfigDb& configDb /**< a subhash of the individual configuration
* parameters for this instance of this plugin. */
) = 0;
/**<
* @note
* The parent service may call the readConfig method at any time to
* indicate that the configuration may have changed. The plugin
* should reinitialize itself based on the configuration that exists when
* this is called. The fact that it is a subhash means that whatever prefix
* is used to identify the plugin (see PluginHooks) has been removed (see the
* examples in PluginHooks::readConfig).
*/
protected:
/// Derived constructors should be private so that only the Factory can call them.
Plugin(const UtlString& instanceName) :
mInstanceName(instanceName)
{
};
/// The instance name from the configuration directive - for logging and other identification.
UtlString mInstanceName;
private:
/// There is no copy constructor.
Plugin(const Plugin&);
/// There is no assignment operator.
Plugin& operator=(const Plugin&);
};
#endif // _PLUGIN_H_
|