Merge branch 'master' of ssh://opensimulator.org/var/git/opensim

OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.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 OpenSimulator 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 System;
+using System.Collections.Generic;
+using OpenMetaverse;
+
+namespace OpenSim.Region.Framework.Interfaces
+{
+    public interface IAgentStatefulModule
+    {
+        /// <summary>
+        /// Returns a list of all the formats (by UUID) that this module
+        /// can render agent state in.
+        /// </summary>
+        List<UUID> GetRenderStateFormats();
+
+        /// <summary>
+        /// Returns a list (by UUID) of all formats this module can decode
+        /// to populate it's internal agent-related state.
+        /// </summary>
+        List<UUID> GetAcceptStateFormats();
+
+        /// <summary>
+        /// Render all internally held state for the given agent in the
+        /// requested format.
+        /// </summary>
+        string RenderState(UUID agentID, UUID format);
+
+        /// <summary>
+        /// Populate the internal state for the given agent from the
+        /// data argument, which is in the specified format. All prior
+        /// state relating to this agent is removed by this operation.
+        /// </summary>
+        bool ReceiveState(UUID agentID, UUID format, string data);
+    }
+}