From 4ce4834f5947350da0739c83f7e74015c103dc2c Mon Sep 17 00:00:00 2001
From: Adam Frisby
Date: Fri, 4 May 2007 07:01:37 +0000
Subject: * Added support for user/asset server keys per-region (warning:
 changes table layout in SQL storages)

---
 OpenGrid.Framework.Data/GridData.cs | 41 +++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

(limited to 'OpenGrid.Framework.Data/GridData.cs')

diff --git a/OpenGrid.Framework.Data/GridData.cs b/OpenGrid.Framework.Data/GridData.cs
index d6b5a2b..3b052fb 100644
--- a/OpenGrid.Framework.Data/GridData.cs
+++ b/OpenGrid.Framework.Data/GridData.cs
@@ -4,14 +4,55 @@ using System.Text;
 
 namespace OpenGrid.Framework.Data
 {
+    /// <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(libsecondlife.LLUUID UUID);
+
+        /// <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(libsecondlife.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();
     }
 }
-- 
cgit v1.1