GridData.cs 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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 OpenSim 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.Collections.Generic;
  28. using libsecondlife;
  29. namespace OpenSim.Framework.Data
  30. {
  31. public enum DataResponse
  32. {
  33. RESPONSE_OK,
  34. RESPONSE_AUTHREQUIRED,
  35. RESPONSE_INVALIDCREDENTIALS,
  36. RESPONSE_ERROR
  37. }
  38. /// <summary>
  39. /// A standard grid interface
  40. /// </summary>
  41. public interface IGridData
  42. {
  43. /// <summary>
  44. /// Returns a sim profile from a regionHandle
  45. /// </summary>
  46. /// <param name="regionHandle">A 64bit Region Handle</param>
  47. /// <returns>A simprofile</returns>
  48. RegionProfileData GetProfileByHandle(ulong regionHandle);
  49. /// <summary>
  50. /// Returns a sim profile from a UUID
  51. /// </summary>
  52. /// <param name="UUID">A 128bit UUID</param>
  53. /// <returns>A sim profile</returns>
  54. RegionProfileData GetProfileByLLUUID(LLUUID UUID);
  55. /// <summary>
  56. /// Returns a sim profile from a string match
  57. /// </summary>
  58. /// <param name="regionName">A string for a partial region name match</param>
  59. /// <returns>A sim profile</returns>
  60. RegionProfileData GetProfileByString(string regionName);
  61. /// <summary>
  62. /// Returns all profiles within the specified range
  63. /// </summary>
  64. /// <param name="Xmin">Minimum sim coordinate (X)</param>
  65. /// <param name="Ymin">Minimum sim coordinate (Y)</param>
  66. /// <param name="Xmax">Maximum sim coordinate (X)</param>
  67. /// <param name="Ymin">Maximum sim coordinate (Y)</param>
  68. /// <returns>An array containing all the sim profiles in the specified range</returns>
  69. RegionProfileData[] GetProfilesInRange(uint Xmin, uint Ymin, uint Xmax, uint Ymax);
  70. /// <summary>
  71. /// Authenticates a sim by use of its recv key.
  72. /// WARNING: Insecure
  73. /// </summary>
  74. /// <param name="UUID">The UUID sent by the sim</param>
  75. /// <param name="regionHandle">The regionhandle sent by the sim</param>
  76. /// <param name="simrecvkey">The receiving key sent by the sim</param>
  77. /// <returns>Whether the sim has been authenticated</returns>
  78. bool AuthenticateSim(LLUUID UUID, ulong regionHandle, string simrecvkey);
  79. /// <summary>
  80. /// Initialises the interface
  81. /// </summary>
  82. void Initialise();
  83. /// <summary>
  84. /// Closes the interface
  85. /// </summary>
  86. void Close();
  87. /// <summary>
  88. /// The plugin being loaded
  89. /// </summary>
  90. /// <returns>A string containing the plugin name</returns>
  91. string getName();
  92. /// <summary>
  93. /// The plugins version
  94. /// </summary>
  95. /// <returns>A string containing the plugin version</returns>
  96. string getVersion();
  97. /// <summary>
  98. /// Adds a new profile to the database
  99. /// </summary>
  100. /// <param name="profile">The profile to add</param>
  101. /// <returns>RESPONSE_OK if successful, error if not.</returns>
  102. DataResponse AddProfile(RegionProfileData profile);
  103. ReservationData GetReservationAtPoint(uint x, uint y);
  104. }
  105. }