blob: f50e97eb007004992af05ce8311bffce7ee55c99 (
plain)
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
|
#ifndef QPID_PLUGIN_H
#define QPID_PLUGIN_H
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
#include "qpid/shared_ptr.h"
#include <boost/noncopyable.hpp>
#include <vector>
#include <boost/function.hpp>
/**@file Generic plug-in framework. */
namespace qpid {
class Options;
/** Generic base class to allow dynamic casting of generic Plugin objects
* to concrete types.
*/
struct Plugin : private boost::noncopyable {
virtual ~Plugin() {}
};
/** Generic interface for anything that uses plug-ins. */
struct PluginUser : boost::noncopyable {
virtual ~PluginUser() {}
/**
* Called by a PluginProvider to provide a plugin.
*
* A concrete PluginUser will dynamic_pointer_cast plugin to a
* class it knows how to use. A PluginUser should ignore plugins
* it does not recognize.
*
* The user will release its shared_ptr when it is finished using
* plugin.
*/
virtual void use(const shared_ptr<Plugin>& plugin) = 0;
};
/**
* Base for classes that provide plug-ins.
*/
class PluginProvider : boost::noncopyable
{
public:
/**
* Register the provider to appear in getProviders()
*
* A concrete PluginProvider is instantiated as a global or static
* member variable in a library so it is registered during static
* initialization when the library is loaded.
*/
PluginProvider();
virtual ~PluginProvider();
/**
* Returns configuration options for the plugin.
* Then will be updated during option parsing by the host program.
*
* @return An options group or 0 for no options. Default returns 0.
* PluginProvider retains ownership of return value.
*/
virtual Options* getOptions();
/** Provide plugins to a PluginUser.
*
* The provider can dynamic_cast the user if it only provides
* plugins to certain types of user. Providers should ignore
* users they don't recognize.
*/
virtual void provide(PluginUser& user) = 0;
/** Get the list of pointers to the registered providers.
* Caller must not delete the pointers.
*/
static const std::vector<PluginProvider*>& getProviders();
private:
static std::vector<PluginProvider*> providers;
};
} // namespace qpid
#endif /*!QPID_PLUGIN_H*/
|
