aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Services/Interfaces/IGridService.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Services/Interfaces/IGridService.cs')
-rw-r--r--OpenSim/Services/Interfaces/IGridService.cs83
1 files changed, 83 insertions, 0 deletions
diff --git a/OpenSim/Services/Interfaces/IGridService.cs b/OpenSim/Services/Interfaces/IGridService.cs
new file mode 100644
index 0000000..25519f7
--- /dev/null
+++ b/OpenSim/Services/Interfaces/IGridService.cs
@@ -0,0 +1,83 @@
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
28using OpenSim.Framework;
29using System.Collections.Generic;
30using OpenMetaverse;
31
32namespace OpenSim.Services.Interfaces
33{
34 public interface IGridService
35 {
36 /// <summary>
37 /// Register a region with the grid service.
38 /// </summary>
39 /// <param name="regionInfos"> </param>
40 /// <returns></returns>
41 /// <exception cref="System.Exception">Thrown if region registration failed</exception>
42 bool RegisterRegion(UUID scopeID, RegionInfo regionInfos);
43
44 /// <summary>
45 /// Deregister a region with the grid service.
46 /// </summary>
47 /// <param name="regionID"></param>
48 /// <returns></returns>
49 /// <exception cref="System.Exception">Thrown if region deregistration failed</exception>
50 bool DeregisterRegion(UUID regionID);
51
52 /// <summary>
53 /// Get information about the regions neighbouring the given co-ordinates.
54 /// </summary>
55 /// <param name="x"></param>
56 /// <param name="y"></param>
57 /// <returns></returns>
58 List<SimpleRegionInfo> RequestNeighbours(UUID scopeID, uint x, uint y);
59
60 RegionInfo RequestNeighbourInfo(UUID regionID);
61
62 RegionInfo RequestClosestRegion(UUID scopeID, string regionName);
63
64 List<MapBlockData> RequestNeighbourMapBlocks(UUID scopeID, int minX, int minY, int maxX, int maxY);
65 // not complete yet, only contains the fields needed for ParcelInfoReqeust
66 LandData RequestLandData(UUID scopeID, ulong regionHandle, uint x, uint y);
67
68 /// <summary>
69 /// Get information about regions starting with the provided name.
70 /// </summary>
71 /// <param name="name">
72 /// The name to match against.
73 /// </param>
74 /// <param name="maxNumber">
75 /// The maximum number of results to return.
76 /// </param>
77 /// <returns>
78 /// A list of <see cref="RegionInfo"/>s of regions with matching name. If the
79 /// grid-server couldn't be contacted or returned an error, return null.
80 /// </returns>
81 List<RegionInfo> RequestNamedRegions(UUID scopeID, string name, int maxNumber);
82 }
83}