clockwerk-opensim-stable – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 vero 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 OpenMetaverse;
29 using OpenSim.Framework;
30 using OpenSim.Region.Framework.Scenes;
31  
32 namespace OpenSim.Region.Framework.Interfaces
33 {
34 public delegate bool ChildAgentUpdateReceived(AgentData data);
35  
36 public interface IInterregionCommsOut
37 {
38 #region Agents
39  
40 bool SendCreateChildAgent(ulong regionHandle, AgentCircuitData aCircuit, uint teleportFlags, out string reason);
41  
42 /// <summary>
43 /// Full child agent update.
44 /// </summary>
45 /// <param name="regionHandle"></param>
46 /// <param name="data"></param>
47 /// <returns></returns>
48 bool SendChildAgentUpdate(ulong regionHandle, AgentData data);
49  
50 /// <summary>
51 /// Short child agent update, mostly for position.
52 /// </summary>
53 /// <param name="regionHandle"></param>
54 /// <param name="data"></param>
55 /// <returns></returns>
56 bool SendChildAgentUpdate(ulong regionHandle, AgentPosition data);
57  
58 bool SendRetrieveRootAgent(ulong regionHandle, UUID id, out IAgentData agent);
59  
60 /// <summary>
61 /// Message from receiving region to departing region, telling it got contacted by the client.
62 /// When sent over REST, it invokes the opaque uri.
63 /// </summary>
64 /// <param name="regionHandle"></param>
65 /// <param name="id"></param>
66 /// <param name="uri"></param>
67 /// <returns></returns>
68 bool SendReleaseAgent(ulong regionHandle, UUID id, string uri);
69  
70 /// <summary>
71 /// Close agent.
72 /// </summary>
73 /// <param name="regionHandle"></param>
74 /// <param name="id"></param>
75 /// <returns></returns>
76 bool SendCloseAgent(ulong regionHandle, UUID id);
77  
78 #endregion Agents
79  
80 #region Objects
81  
82 /// <summary>
83 /// Create an object in the destination region. This message is used primarily for prim crossing.
84 /// </summary>
85 /// <param name="regionHandle"></param>
86 /// <param name="sog"></param>
87 /// <param name="isLocalCall"></param>
88 /// <returns></returns>
89 bool SendCreateObject(ulong regionHandle, SceneObjectGroup sog, bool isLocalCall);
90  
91 /// <summary>
92 /// Create an object from the user's inventory in the destination region.
93 /// This message is used primarily by clients.
94 /// </summary>
95 /// <param name="regionHandle"></param>
96 /// <param name="userID"></param>
97 /// <param name="itemID"></param>
98 /// <returns></returns>
99 bool SendCreateObject(ulong regionHandle, UUID userID, UUID itemID);
100  
101 #endregion Objects
102  
103 }
104  
105 // This may not be needed, but having it here for now.
106 public interface IInterregionCommsIn
107 {
108 event ChildAgentUpdateReceived OnChildAgentUpdate;
109 }
110  
111 }