diff options
Diffstat (limited to 'OpenSim/Framework/Data/GridData.cs')
-rw-r--r-- | OpenSim/Framework/Data/GridData.cs | 222 |
1 files changed, 111 insertions, 111 deletions
diff --git a/OpenSim/Framework/Data/GridData.cs b/OpenSim/Framework/Data/GridData.cs index 5a17d20..c96353b 100644 --- a/OpenSim/Framework/Data/GridData.cs +++ b/OpenSim/Framework/Data/GridData.cs | |||
@@ -1,111 +1,111 @@ | |||
1 | /* | 1 | /* |
2 | * Copyright (c) Contributors, http://www.openmetaverse.org/ | 2 | * Copyright (c) Contributors, http://www.openmetaverse.org/ |
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | 3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. |
4 | * | 4 | * |
5 | * Redistribution and use in source and binary forms, with or without | 5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions are met: | 6 | * modification, are permitted provided that the following conditions are met: |
7 | * * Redistributions of source code must retain the above copyright | 7 | * * Redistributions of source code must retain the above copyright |
8 | * notice, this list of conditions and the following disclaimer. | 8 | * notice, this list of conditions and the following disclaimer. |
9 | * * Redistributions in binary form must reproduce the above copyright | 9 | * * Redistributions in binary form must reproduce the above copyright |
10 | * notice, this list of conditions and the following disclaimer in the | 10 | * notice, this list of conditions and the following disclaimer in the |
11 | * documentation and/or other materials provided with the distribution. | 11 | * documentation and/or other materials provided with the distribution. |
12 | * * Neither the name of the OpenSim Project nor the | 12 | * * Neither the name of the OpenSim Project nor the |
13 | * names of its contributors may be used to endorse or promote products | 13 | * names of its contributors may be used to endorse or promote products |
14 | * derived from this software without specific prior written permission. | 14 | * derived from this software without specific prior written permission. |
15 | * | 15 | * |
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY | 16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY |
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | 17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | 18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | 19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY |
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | 20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | 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 | 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 | 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 | 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. | 25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * | 26 | * |
27 | */ | 27 | */ |
28 | using libsecondlife; | 28 | using libsecondlife; |
29 | 29 | ||
30 | namespace OpenSim.Framework.Data | 30 | namespace OpenSim.Framework.Data |
31 | { | 31 | { |
32 | public enum DataResponse | 32 | public enum DataResponse |
33 | { | 33 | { |
34 | RESPONSE_OK, | 34 | RESPONSE_OK, |
35 | RESPONSE_AUTHREQUIRED, | 35 | RESPONSE_AUTHREQUIRED, |
36 | RESPONSE_INVALIDCREDENTIALS, | 36 | RESPONSE_INVALIDCREDENTIALS, |
37 | RESPONSE_ERROR | 37 | RESPONSE_ERROR |
38 | } | 38 | } |
39 | 39 | ||
40 | /// <summary> | 40 | /// <summary> |
41 | /// A standard grid interface | 41 | /// A standard grid interface |
42 | /// </summary> | 42 | /// </summary> |
43 | public interface IGridData | 43 | public interface IGridData |
44 | { | 44 | { |
45 | /// <summary> | 45 | /// <summary> |
46 | /// Returns a sim profile from a regionHandle | 46 | /// Returns a sim profile from a regionHandle |
47 | /// </summary> | 47 | /// </summary> |
48 | /// <param name="regionHandle">A 64bit Region Handle</param> | 48 | /// <param name="regionHandle">A 64bit Region Handle</param> |
49 | /// <returns>A simprofile</returns> | 49 | /// <returns>A simprofile</returns> |
50 | SimProfileData GetProfileByHandle(ulong regionHandle); | 50 | SimProfileData GetProfileByHandle(ulong regionHandle); |
51 | 51 | ||
52 | /// <summary> | 52 | /// <summary> |
53 | /// Returns a sim profile from a UUID | 53 | /// Returns a sim profile from a UUID |
54 | /// </summary> | 54 | /// </summary> |
55 | /// <param name="UUID">A 128bit UUID</param> | 55 | /// <param name="UUID">A 128bit UUID</param> |
56 | /// <returns>A sim profile</returns> | 56 | /// <returns>A sim profile</returns> |
57 | SimProfileData GetProfileByLLUUID(LLUUID UUID); | 57 | SimProfileData GetProfileByLLUUID(LLUUID UUID); |
58 | 58 | ||
59 | /// <summary> | 59 | /// <summary> |
60 | /// Returns all profiles within the specified range | 60 | /// Returns all profiles within the specified range |
61 | /// </summary> | 61 | /// </summary> |
62 | /// <param name="Xmin">Minimum sim coordinate (X)</param> | 62 | /// <param name="Xmin">Minimum sim coordinate (X)</param> |
63 | /// <param name="Ymin">Minimum sim coordinate (Y)</param> | 63 | /// <param name="Ymin">Minimum sim coordinate (Y)</param> |
64 | /// <param name="Xmax">Maximum sim coordinate (X)</param> | 64 | /// <param name="Xmax">Maximum sim coordinate (X)</param> |
65 | /// <param name="Ymin">Maximum sim coordinate (Y)</param> | 65 | /// <param name="Ymin">Maximum sim coordinate (Y)</param> |
66 | /// <returns>An array containing all the sim profiles in the specified range</returns> | 66 | /// <returns>An array containing all the sim profiles in the specified range</returns> |
67 | SimProfileData[] GetProfilesInRange(uint Xmin, uint Ymin, uint Xmax, uint Ymax); | 67 | SimProfileData[] GetProfilesInRange(uint Xmin, uint Ymin, uint Xmax, uint Ymax); |
68 | 68 | ||
69 | /// <summary> | 69 | /// <summary> |
70 | /// Authenticates a sim by use of it's recv key. | 70 | /// Authenticates a sim by use of it's recv key. |
71 | /// WARNING: Insecure | 71 | /// WARNING: Insecure |
72 | /// </summary> | 72 | /// </summary> |
73 | /// <param name="UUID">The UUID sent by the sim</param> | 73 | /// <param name="UUID">The UUID sent by the sim</param> |
74 | /// <param name="regionHandle">The regionhandle sent by the sim</param> | 74 | /// <param name="regionHandle">The regionhandle sent by the sim</param> |
75 | /// <param name="simrecvkey">The recieving key sent by the sim</param> | 75 | /// <param name="simrecvkey">The recieving key sent by the sim</param> |
76 | /// <returns>Whether the sim has been authenticated</returns> | 76 | /// <returns>Whether the sim has been authenticated</returns> |
77 | bool AuthenticateSim(LLUUID UUID, ulong regionHandle, string simrecvkey); | 77 | bool AuthenticateSim(LLUUID UUID, ulong regionHandle, string simrecvkey); |
78 | 78 | ||
79 | /// <summary> | 79 | /// <summary> |
80 | /// Initialises the interface | 80 | /// Initialises the interface |
81 | /// </summary> | 81 | /// </summary> |
82 | void Initialise(); | 82 | void Initialise(); |
83 | 83 | ||
84 | /// <summary> | 84 | /// <summary> |
85 | /// Closes the interface | 85 | /// Closes the interface |
86 | /// </summary> | 86 | /// </summary> |
87 | void Close(); | 87 | void Close(); |
88 | 88 | ||
89 | /// <summary> | 89 | /// <summary> |
90 | /// The plugin being loaded | 90 | /// The plugin being loaded |
91 | /// </summary> | 91 | /// </summary> |
92 | /// <returns>A string containing the plugin name</returns> | 92 | /// <returns>A string containing the plugin name</returns> |
93 | string getName(); | 93 | string getName(); |
94 | 94 | ||
95 | /// <summary> | 95 | /// <summary> |
96 | /// The plugins version | 96 | /// The plugins version |
97 | /// </summary> | 97 | /// </summary> |
98 | /// <returns>A string containing the plugin version</returns> | 98 | /// <returns>A string containing the plugin version</returns> |
99 | string getVersion(); | 99 | string getVersion(); |
100 | 100 | ||
101 | /// <summary> | 101 | /// <summary> |
102 | /// Adds a new profile to the database | 102 | /// Adds a new profile to the database |
103 | /// </summary> | 103 | /// </summary> |
104 | /// <param name="profile">The profile to add</param> | 104 | /// <param name="profile">The profile to add</param> |
105 | /// <returns>RESPONSE_OK if successful, error if not.</returns> | 105 | /// <returns>RESPONSE_OK if successful, error if not.</returns> |
106 | DataResponse AddProfile(SimProfileData profile); | 106 | DataResponse AddProfile(SimProfileData profile); |
107 | 107 | ||
108 | ReservationData GetReservationAtPoint(uint x, uint y); | 108 | ReservationData GetReservationAtPoint(uint x, uint y); |
109 | 109 | ||
110 | } | 110 | } |
111 | } | 111 | } |