* Bringing Sugilite in to trunk

author: Adam Frisby 2007-07-11 08:10:25 +0000
committer: Adam Frisby 2007-07-11 08:10:25 +0000
commit: e2ff441e31328e60c8bb1d4bb32fa4ac64f91978 (patch)
tree: 8405b6cef57b66a58f31a24c859846085d0b81f7 /OpenSim/Framework/Data/GridData.cs
parent: * Wiping trunk in prep for Sugilite (diff)
parent: * Applying dalien's patches from bug#177 and #179 (diff)
download: opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.zip
opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.gz
opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.bz2
opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.xz
1 files changed, 111 insertions, 0 deletions
diff --git a/OpenSim/Framework/Data/GridData.cs b/OpenSim/Framework/Data/GridData.cs
new file mode 100644
index 0000000..5a17d20
--- /dev/null
+++ b/OpenSim/Framework/Data/GridData.cs
@@ -0,0 +1,111 @@
+/*
+* Copyright (c) Contributors, http://www.openmetaverse.org/
+* See CONTRIBUTORS.TXT for a full list of copyright holders.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the OpenSim Project nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+* 
+*/
+using libsecondlife;
+namespace OpenSim.Framework.Data
+{
+    public enum DataResponse
+    {
+        RESPONSE_OK,
+        RESPONSE_AUTHREQUIRED,
+        RESPONSE_INVALIDCREDENTIALS,
+        RESPONSE_ERROR
+    }
+    /// <summary>
+    /// A standard grid interface
+    /// </summary>
+    public interface IGridData
+    {
+        /// <summary>
+        /// Returns a sim profile from a regionHandle
+        /// </summary>
+        /// <param name="regionHandle">A 64bit Region Handle</param>
+        /// <returns>A simprofile</returns>
+        SimProfileData GetProfileByHandle(ulong regionHandle);
+        /// <summary>
+        /// Returns a sim profile from a UUID
+        /// </summary>
+        /// <param name="UUID">A 128bit UUID</param>
+        /// <returns>A sim profile</returns>
+        SimProfileData GetProfileByLLUUID(LLUUID UUID);
+        /// <summary>
+        /// Returns all profiles within the specified range
+        /// </summary>
+        /// <param name="Xmin">Minimum sim coordinate (X)</param>
+        /// <param name="Ymin">Minimum sim coordinate (Y)</param>
+        /// <param name="Xmax">Maximum sim coordinate (X)</param>
+        /// <param name="Ymin">Maximum sim coordinate (Y)</param>
+        /// <returns>An array containing all the sim profiles in the specified range</returns>
+        SimProfileData[] GetProfilesInRange(uint Xmin, uint Ymin, uint Xmax, uint Ymax);
+        /// <summary>
+        /// Authenticates a sim by use of it's recv key. 
+        /// WARNING: Insecure
+        /// </summary>
+        /// <param name="UUID">The UUID sent by the sim</param>
+        /// <param name="regionHandle">The regionhandle sent by the sim</param>
+        /// <param name="simrecvkey">The recieving key sent by the sim</param>
+        /// <returns>Whether the sim has been authenticated</returns>
+        bool AuthenticateSim(LLUUID UUID, ulong regionHandle, string simrecvkey);
+        /// <summary>
+        /// Initialises the interface
+        /// </summary>
+        void Initialise();
+        /// <summary>
+        /// Closes the interface
+        /// </summary>
+        void Close();
+        /// <summary>
+        /// The plugin being loaded
+        /// </summary>
+        /// <returns>A string containing the plugin name</returns>
+        string getName();
+        /// <summary>
+        /// The plugins version
+        /// </summary>
+        /// <returns>A string containing the plugin version</returns>
+        string getVersion();
+        /// <summary>
+        /// Adds a new profile to the database
+        /// </summary>
+        /// <param name="profile">The profile to add</param>
+        /// <returns>RESPONSE_OK if successful, error if not.</returns>
+        DataResponse AddProfile(SimProfileData profile);
+        ReservationData GetReservationAtPoint(uint x, uint y);
+    }
+}
author	Adam Frisby	2007-07-11 08:10:25 +0000
committer	Adam Frisby	2007-07-11 08:10:25 +0000
commit	e2ff441e31328e60c8bb1d4bb32fa4ac64f91978 (patch)
tree	8405b6cef57b66a58f31a24c859846085d0b81f7 /OpenSim/Framework/Data/GridData.cs
parent	* Wiping trunk in prep for Sugilite (diff)
parent	* Applying dalien's patches from bug#177 and #179 (diff)
download	opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.zip opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.gz opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.bz2 opensim-SC-e2ff441e31328e60c8bb1d4bb32fa4ac64f91978.tar.xz

diff --git a/OpenSim/Framework/Data/GridData.cs b/OpenSim/Framework/Data/GridData.cs new file mode 100644 index 0000000..5a17d20 --- /dev/null +++ b/OpenSim/Framework/Data/GridData.cs
@@ -0,0 +1,111 @@
	1	/*
	2	* Copyright (c) Contributors, http://www.openmetaverse.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	*/
	28	using libsecondlife;
	29
	30	namespace OpenSim.Framework.Data
	31	{
	32	public enum DataResponse
	33	{
	34	RESPONSE_OK,
	35	RESPONSE_AUTHREQUIRED,
	36	RESPONSE_INVALIDCREDENTIALS,
	37	RESPONSE_ERROR
	38	}
	39
	40	/// <summary>
	41	/// A standard grid interface
	42	/// </summary>
	43	public interface IGridData
	44	{
	45	/// <summary>
	46	/// Returns a sim profile from a regionHandle
	47	/// </summary>
	48	/// <param name="regionHandle">A 64bit Region Handle</param>
	49	/// <returns>A simprofile</returns>
	50	SimProfileData GetProfileByHandle(ulong regionHandle);
	51
	52	/// <summary>
	53	/// Returns a sim profile from a UUID
	54	/// </summary>
	55	/// <param name="UUID">A 128bit UUID</param>
	56	/// <returns>A sim profile</returns>
	57	SimProfileData GetProfileByLLUUID(LLUUID UUID);
	58
	59	/// <summary>
	60	/// Returns all profiles within the specified range
	61	/// </summary>
	62	/// <param name="Xmin">Minimum sim coordinate (X)</param>
	63	/// <param name="Ymin">Minimum sim coordinate (Y)</param>
	64	/// <param name="Xmax">Maximum sim coordinate (X)</param>
	65	/// <param name="Ymin">Maximum sim coordinate (Y)</param>
	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);
	68
	69	/// <summary>
	70	/// Authenticates a sim by use of it's recv key.
	71	/// WARNING: Insecure
	72	/// </summary>
	73	/// <param name="UUID">The UUID 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>
	76	/// <returns>Whether the sim has been authenticated</returns>
	77	bool AuthenticateSim(LLUUID UUID, ulong regionHandle, string simrecvkey);
	78
	79	/// <summary>
	80	/// Initialises the interface
	81	/// </summary>
	82	void Initialise();
	83
	84	/// <summary>
	85	/// Closes the interface
	86	/// </summary>
	87	void Close();
	88
	89	/// <summary>
	90	/// The plugin being loaded
	91	/// </summary>
	92	/// <returns>A string containing the plugin name</returns>
	93	string getName();
	94
	95	/// <summary>
	96	/// The plugins version
	97	/// </summary>
	98	/// <returns>A string containing the plugin version</returns>
	99	string getVersion();
	100
	101	/// <summary>
	102	/// Adds a new profile to 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 AddProfile(SimProfileData profile);
	107
	108	ReservationData GetReservationAtPoint(uint x, uint y);
	109
	110	}
	111	}