aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Data/IGridData.cs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--OpenSim/Data/IGridData.cs134
1 files changed, 0 insertions, 134 deletions
diff --git a/OpenSim/Data/IGridData.cs b/OpenSim/Data/IGridData.cs
deleted file mode 100644
index 8bd3811..0000000
--- a/OpenSim/Data/IGridData.cs
+++ /dev/null
@@ -1,134 +0,0 @@
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
28using System.Collections.Generic;
29using OpenMetaverse;
30using OpenSim.Framework;
31
32namespace OpenSim.Data
33{
34 public enum DataResponse
35 {
36 RESPONSE_OK,
37 RESPONSE_AUTHREQUIRED,
38 RESPONSE_INVALIDCREDENTIALS,
39 RESPONSE_ERROR
40 }
41
42 /// <summary>
43 /// A standard grid interface
44 /// </summary>
45 public interface IGridDataPlugin : IPlugin
46 {
47 /// <summary>
48 /// Initialises the interface
49 /// </summary>
50 void Initialise(string connect);
51
52 /// <summary>
53 /// Returns a sim profile from a regionHandle
54 /// </summary>
55 /// <param name="regionHandle">A 64bit Region Handle</param>
56 /// <returns>A simprofile</returns>
57 RegionProfileData GetProfileByHandle(ulong regionHandle);
58
59 /// <summary>
60 /// Returns a sim profile from a UUID
61 /// </summary>
62 /// <param name="UUID">A 128bit UUID</param>
63 /// <returns>A sim profile</returns>
64 RegionProfileData GetProfileByUUID(UUID UUID);
65
66 /// <summary>
67 /// Returns a sim profile from a string match
68 /// </summary>
69 /// <param name="regionName">A string for a partial region name match</param>
70 /// <returns>A sim profile</returns>
71 RegionProfileData GetProfileByString(string regionName);
72
73 /// <summary>
74 /// Returns all profiles within the specified range
75 /// </summary>
76 /// <param name="Xmin">Minimum sim coordinate (X)</param>
77 /// <param name="Ymin">Minimum sim coordinate (Y)</param>
78 /// <param name="Xmax">Maximum sim coordinate (X)</param>
79 /// <param name="Ymin">Maximum sim coordinate (Y)</param>
80 /// <returns>An array containing all the sim profiles in the specified range</returns>
81 RegionProfileData[] GetProfilesInRange(uint Xmin, uint Ymin, uint Xmax, uint Ymax);
82
83 /// <summary>
84 /// Returns up to maxNum profiles of regions that have a name starting with namePrefix
85 /// </summary>
86 /// <param name="name">The name to match against</param>
87 /// <param name="maxNum">Maximum number of profiles to return</param>
88 /// <returns>A list of sim profiles</returns>
89 List<RegionProfileData> GetRegionsByName(string namePrefix, uint maxNum);
90
91 /// <summary>
92 /// Authenticates a sim by use of its recv key.
93 /// WARNING: Insecure
94 /// </summary>
95 /// <param name="UUID">The UUID sent by the sim</param>
96 /// <param name="regionHandle">The regionhandle sent by the sim</param>
97 /// <param name="simrecvkey">The receiving key sent by the sim</param>
98 /// <returns>Whether the sim has been authenticated</returns>
99 bool AuthenticateSim(UUID UUID, ulong regionHandle, string simrecvkey);
100
101 /// <summary>
102 /// Adds or updates a profile in the database
103 /// </summary>
104 /// <param name="profile">The profile to add</param>
105 /// <returns>RESPONSE_OK if successful, error if not.</returns>
106 DataResponse StoreProfile(RegionProfileData profile);
107
108 /// <summary>
109 /// Remove a profile from the database
110 /// </summary>
111 /// <param name="UUID">ID of profile to remove</param>
112 /// <returns></returns>
113 DataResponse DeleteProfile(string UUID);
114
115 /// <summary>
116 /// Function not used????
117 /// </summary>
118 /// <param name="x"></param>
119 /// <param name="y"></param>
120 /// <returns></returns>
121 ReservationData GetReservationAtPoint(uint x, uint y);
122 }
123
124 public class GridDataInitialiser : PluginInitialiserBase
125 {
126 private string connect;
127 public GridDataInitialiser (string s) { connect = s; }
128 public override void Initialise (IPlugin plugin)
129 {
130 IGridDataPlugin p = plugin as IGridDataPlugin;
131 p.Initialise (connect);
132 }
133 }
134}
generated by cgit v1.1 at 2024-12-21 08:23:32 +0000