summaryrefslogtreecommitdiff
path: root/cpp/slice/Ice/Plugin.ice
blob: 7f237f3d1441694a68c37148d5bbd7d8aad4d3c3 (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
// **********************************************************************
//
// Copyright (c) 2002
// ZeroC, Inc.
// Huntsville, AL, USA
//
// All Rights Reserved
//
// **********************************************************************

#ifndef ICE_PLUGIN_ICE
#define ICE_PLUGIN_ICE

#include <Ice/LocalException.ice>

module Ice
{

/**
 *
 * A Communicator plug-in. A plug-in generally adds a feature to a
 * Communicator, such as support for a protocol.
 *
 **/
local interface Plugin
{
    /**
     *
     * Called when the Communicator is being destroyed.
     *
     **/
    void destroy();
};

/**
 *
 * Each Communicator has a PluginManager to administer the set of
 * plug-ins.
 *
 **/
local interface PluginManager
{
    /**
     *
     * Obtain a plug-in by name.
     *
     * @param name The plug-in's name.
     *
     * @return The plug-in.
     *
     * @throws PluginNotFoundException Raised if no plug-in was
     * found with the given name.
     *
     **/
    Plugin getPlugin(string name)
        throws PluginNotFoundException;

    /**
     *
     * Install a new plug-in.
     *
     * @param name The plug-in's name.
     *
     * @param pi The plug-in.
     *
     * @throws PluginExistsException Raised if a plug-in already
     * exists with the given name.
     *
     **/
    void addPlugin(string name, Plugin pi)
        throws PluginExistsException;

    /**
     *
     * Called when the Communicator is being destroyed.
     *
     **/
    void destroy();
};

};

#endif