1
0

IPlugin.cs 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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. using System;
  28. namespace OpenSim.Framework
  29. {
  30. /// <summary>
  31. /// Exception thrown if Initialise has been called, but failed.
  32. /// </summary>
  33. public class PluginNotInitialisedException : Exception
  34. {
  35. public PluginNotInitialisedException () : base() {}
  36. public PluginNotInitialisedException (string msg) : base(msg) {}
  37. public PluginNotInitialisedException (string msg, Exception e) : base(msg, e) {}
  38. }
  39. /// <summary>
  40. /// This interface, describes a generic plugin
  41. /// </summary>
  42. public interface IPlugin : IDisposable
  43. {
  44. /// <summary>
  45. /// Returns the plugin version
  46. /// </summary>
  47. /// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns>
  48. string Version { get; }
  49. /// <summary>
  50. /// Returns the plugin name
  51. /// </summary>
  52. /// <returns>Plugin name, eg MySQL User Provider</returns>
  53. string Name { get; }
  54. /// <summary>
  55. /// Default-initialises the plugin
  56. /// </summary>
  57. void Initialise();
  58. }
  59. /// <summary>
  60. /// Any plugins which need to pass parameters to their initialisers must
  61. /// inherit this class and use it to set the PluginLoader Initialiser property
  62. /// </summary>
  63. public class PluginInitialiserBase
  64. {
  65. // this would be a lot simpler if C# supported currying or typedefs
  66. // default initialisation
  67. public virtual void Initialise (IPlugin plugin)
  68. {
  69. plugin.Initialise();
  70. }
  71. }
  72. }