diff options
author | Melanie Thielker | 2015-08-15 19:08:45 +0200 |
---|---|---|
committer | Melanie Thielker | 2015-08-15 19:08:45 +0200 |
commit | 2374c4a4c18c6daf15d1d662409a35e0f969b9e4 (patch) | |
tree | 5acfa65d8c3a134d8bdcc5168ee5298d6546e248 /OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs | |
parent | Merge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff) | |
download | opensim-SC_OLD-2374c4a4c18c6daf15d1d662409a35e0f969b9e4.zip opensim-SC_OLD-2374c4a4c18c6daf15d1d662409a35e0f969b9e4.tar.gz opensim-SC_OLD-2374c4a4c18c6daf15d1d662409a35e0f969b9e4.tar.bz2 opensim-SC_OLD-2374c4a4c18c6daf15d1d662409a35e0f969b9e4.tar.xz |
Adding the IAgentStatefulModule interface. It is used in addtion to
one of the existing module interfaces to denote a module that holds
agent specific state that should be transferred to other regions
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs b/OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs new file mode 100644 index 0000000..ccb2a03 --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/IAgentStatefulModule.cs | |||
@@ -0,0 +1,61 @@ | |||
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 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | using OpenMetaverse; | ||
31 | |||
32 | namespace OpenSim.Region.Framework.Interfaces | ||
33 | { | ||
34 | public interface IAgentStatefulModule | ||
35 | { | ||
36 | /// <summary> | ||
37 | /// Returns a list of all the formats (by UUID) that this module | ||
38 | /// can render agent state in. | ||
39 | /// </summary> | ||
40 | List<UUID> GetRenderStateFormats(); | ||
41 | |||
42 | /// <summary> | ||
43 | /// Returns a list (by UUID) of all formats this module can decode | ||
44 | /// to populate it's internal agent-related state. | ||
45 | /// </summary> | ||
46 | List<UUID> GetAcceptStateFormats(); | ||
47 | |||
48 | /// <summary> | ||
49 | /// Render all internally held state for the given agent in the | ||
50 | /// requested format. | ||
51 | /// </summary> | ||
52 | string RenderState(UUID agentID, UUID format); | ||
53 | |||
54 | /// <summary> | ||
55 | /// Populate the internal state for the given agent from the | ||
56 | /// data argument, which is in the specified format. All prior | ||
57 | /// state relating to this agent is removed by this operation. | ||
58 | /// </summary> | ||
59 | bool ReceiveState(UUID agentID, UUID format, string data); | ||
60 | } | ||
61 | } | ||