aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs
diff options
context:
space:
mode:
authorDr Scofield2009-02-06 16:55:34 +0000
committerDr Scofield2009-02-06 16:55:34 +0000
commit9b66108081a8c8cf79faaa6c541554091c40850e (patch)
tree095a232ae5a9de3a9244bcd34da08294f61eeea5 /OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs
parent* removed superfluous constants class (diff)
downloadopensim-SC_OLD-9b66108081a8c8cf79faaa6c541554091c40850e.zip
opensim-SC_OLD-9b66108081a8c8cf79faaa6c541554091c40850e.tar.gz
opensim-SC_OLD-9b66108081a8c8cf79faaa6c541554091c40850e.tar.bz2
opensim-SC_OLD-9b66108081a8c8cf79faaa6c541554091c40850e.tar.xz
This changeset is the step 1 of 2 in refactoring
OpenSim.Region.Environment into a "framework" part and a modules only part. This first changeset refactors OpenSim.Region.Environment.Scenes, OpenSim.Region.Environment.Interfaces, and OpenSim.Region.Interfaces into OpenSim.Region.Framework.{Interfaces,Scenes} leaving only region modules in OpenSim.Region.Environment. The next step will be to move region modules up from OpenSim.Region.Environment.Modules to OpenSim.Region.CoreModules and then sort out which modules are really core modules and which should move out to forge. I've been very careful to NOT BREAK anything. i hope i've succeeded. as this is the work of a whole week i hope i managed to keep track with the applied patches of the last week --- could any of you that did check in stuff have a look at whether it survived? thx!
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs109
1 files changed, 109 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs b/OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs
new file mode 100644
index 0000000..46d81ce
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/IRegionDataStore.cs
@@ -0,0 +1,109 @@
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 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
28using System.Collections.Generic;
29using OpenMetaverse;
30using OpenSim.Framework;
31using OpenSim.Region.Framework.Scenes;
32
33namespace OpenSim.Region.Framework.Interfaces
34{
35 public interface IRegionDataStore
36 {
37 /// <summary>
38 /// Initialises the data storage engine
39 /// </summary>
40 /// <param name="filename">The file to save the database to (may not be applicable). Alternatively,
41 /// a connection string for the database</param>
42 void Initialise(string filename);
43
44 /// <summary>
45 /// Dispose the database
46 /// </summary>
47 void Dispose();
48
49 /// <summary>
50 /// Stores all object's details apart from inventory
51 /// </summary>
52 /// <param name="obj"></param>
53 /// <param name="regionUUID"></param>
54 void StoreObject(SceneObjectGroup obj, UUID regionUUID);
55
56 /// <summary>
57 /// Entirely removes the object, including inventory
58 /// </summary>
59 /// <param name="uuid"></param>
60 /// <param name="regionUUID"></param>
61 /// <returns></returns>
62 void RemoveObject(UUID uuid, UUID regionUUID);
63
64 /// <summary>
65 /// Store a prim's inventory
66 /// </summary>
67 /// <returns></returns>
68 void StorePrimInventory(UUID primID, ICollection<TaskInventoryItem> items);
69
70 /// <summary>
71 /// Load persisted objects from region storage.
72 /// </summary>
73 /// <param name="regionUUID">the Region UUID</param>
74 /// <returns>List of loaded groups</returns>
75 List<SceneObjectGroup> LoadObjects(UUID regionUUID);
76
77 /// <summary>
78 /// Store a terrain revision in region storage
79 /// </summary>
80 /// <param name="ter">HeightField data</param>
81 /// <param name="regionID">region UUID</param>
82 void StoreTerrain(double[,] terrain, UUID regionID);
83
84 /// <summary>
85 /// Load the latest terrain revision from region storage
86 /// </summary>
87 /// <param name="regionID">the region UUID</param>
88 /// <returns>Heightfield data</returns>
89 double[,] LoadTerrain(UUID regionID);
90
91 void StoreLandObject(ILandObject Parcel);
92
93 /// <summary>
94 /// <list type="bullet">
95 /// <item>delete from land where UUID=globalID</item>
96 /// <item>delete from landaccesslist where LandUUID=globalID</item>
97 /// </list>
98 /// </summary>
99 /// <param name="globalID"></param>
100 void RemoveLandObject(UUID globalID);
101
102 List<LandData> LoadLandObjects(UUID regionUUID);
103
104 void StoreRegionSettings(RegionSettings rs);
105 RegionSettings LoadRegionSettings(UUID regionUUID);
106
107 void Shutdown();
108 }
109}