opensim – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | eva | 1 | /* |
2 | * Copyright (c) Contributors, http://opensimulator.org/ |
||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. |
||
4 | * |
||
5 | * Redistribution and use in source and binary forms, with or without |
||
6 | * modification, are permitted provided that the following conditions are met: |
||
7 | * * Redistributions of source code must retain the above copyright |
||
8 | * notice, this list of conditions and the following disclaimer. |
||
9 | * * Redistributions in binary form must reproduce the above copyright |
||
10 | * notice, this list of conditions and the following disclaimer in the |
||
11 | * documentation and/or other materials provided with the distribution. |
||
12 | * * Neither the name of the OpenSimulator Project nor the |
||
13 | * names of its contributors may be used to endorse or promote products |
||
14 | * derived from this software without specific prior written permission. |
||
15 | * |
||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY |
||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY |
||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
26 | */ |
||
27 | |||
28 | using System; |
||
29 | |||
30 | namespace OpenSim.Framework |
||
31 | { |
||
32 | /// <summary> |
||
33 | /// Exception thrown if Initialise has been called, but failed. |
||
34 | /// </summary> |
||
35 | public class PluginNotInitialisedException : Exception |
||
36 | { |
||
37 | public PluginNotInitialisedException () : base() {} |
||
38 | public PluginNotInitialisedException (string msg) : base(msg) {} |
||
39 | public PluginNotInitialisedException (string msg, Exception e) : base(msg, e) {} |
||
40 | } |
||
41 | |||
42 | /// <summary> |
||
43 | /// This interface, describes a generic plugin |
||
44 | /// </summary> |
||
45 | public interface IPlugin : IDisposable |
||
46 | { |
||
47 | /// <summary> |
||
48 | /// Returns the plugin version |
||
49 | /// </summary> |
||
50 | /// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns> |
||
51 | string Version { get; } |
||
52 | |||
53 | /// <summary> |
||
54 | /// Returns the plugin name |
||
55 | /// </summary> |
||
56 | /// <returns>Plugin name, eg MySQL User Provider</returns> |
||
57 | string Name { get; } |
||
58 | |||
59 | /// <summary> |
||
60 | /// Default-initialises the plugin |
||
61 | /// </summary> |
||
62 | void Initialise(); |
||
63 | } |
||
64 | |||
65 | /// <summary> |
||
66 | /// Any plugins which need to pass parameters to their initialisers must |
||
67 | /// inherit this class and use it to set the PluginLoader Initialiser property |
||
68 | /// </summary> |
||
69 | public class PluginInitialiserBase |
||
70 | { |
||
71 | // this would be a lot simpler if C# supported currying or typedefs |
||
72 | |||
73 | // default initialisation |
||
74 | public virtual void Initialise (IPlugin plugin) |
||
75 | { |
||
76 | plugin.Initialise(); |
||
77 | } |
||
78 | } |
||
79 | |||
80 | } |