clockwerk-opensim – 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 System;
29 using OpenMetaverse;
30 using OpenSim.Framework;
31  
32 namespace OpenSim.Region.Framework.Interfaces
33 {
34 public interface IWorldCommListenerInfo
35 {
36 Object[] GetSerializationData();
37 UUID GetItemID();
38 UUID GetHostID();
39 int GetChannel();
40 uint GetLocalID();
41 int GetHandle();
42 string GetMessage();
43 string GetName();
44 bool IsActive();
45 void Deactivate();
46 void Activate();
47 UUID GetID();
48  
49 /// <summary>
50 /// Bitfield indicating which strings should be processed as regex.
51 /// 1 corresponds to IWorldCommListenerInfo::GetName()
52 /// 2 corresponds to IWorldCommListenerInfo::GetMessage()
53 /// </summary>
54 int RegexBitfield { get; }
55 }
56  
57 public interface IWorldComm
58 {
59 /// <summary>
60 /// Total number of listeners
61 /// </summary>
62 int ListenerCount { get; }
63  
64 /// <summary>
65 /// Create a listen event callback with the specified filters.
66 /// The parameters localID,itemID are needed to uniquely identify
67 /// the script during 'peek' time. Parameter hostID is needed to
68 /// determine the position of the script.
69 /// </summary>
70 /// <param name="LocalID">localID of the script engine</param>
71 /// <param name="itemID">UUID of the script engine</param>
72 /// <param name="hostID">UUID of the SceneObjectPart</param>
73 /// <param name="channel">channel to listen on</param>
74 /// <param name="name">name to filter on</param>
75 /// <param name="id">key to filter on (user given, could be totally faked)</param>
76 /// <param name="msg">msg to filter on</param>
77 /// <returns>number of the scripts handle</returns>
78 int Listen(uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg);
79  
80 /// <summary>
81 /// Create a listen event callback with the specified filters.
82 /// The parameters localID,itemID are needed to uniquely identify
83 /// the script during 'peek' time. Parameter hostID is needed to
84 /// determine the position of the script.
85 /// </summary>
86 /// <param name="LocalID">localID of the script engine</param>
87 /// <param name="itemID">UUID of the script engine</param>
88 /// <param name="hostID">UUID of the SceneObjectPart</param>
89 /// <param name="channel">channel to listen on</param>
90 /// <param name="name">name to filter on</param>
91 /// <param name="id">key to filter on (user given, could be totally faked)</param>
92 /// <param name="msg">msg to filter on</param>
93 /// <param name="regexBitfield">Bitfield indicating which strings should be processed as regex.</param>
94 /// <returns>number of the scripts handle</returns>
95 int Listen(uint LocalID, UUID itemID, UUID hostID, int channel, string name, UUID id, string msg, int regexBitfield);
96  
97 /// <summary>
98 /// This method scans over the objects which registered an interest in listen callbacks.
99 /// For everyone it finds, it checks if it fits the given filter. If it does, then
100 /// enqueue the message for delivery to the objects listen event handler.
101 /// The enqueued ListenerInfo no longer has filter values, but the actually trigged values.
102 /// Objects that do an llSay have their messages delivered here and for nearby avatars,
103 /// the OnChatFromClient event is used.
104 /// </summary>
105 /// <param name="type">type of delvery (whisper,say,shout or regionwide)</param>
106 /// <param name="channel">channel to sent on</param>
107 /// <param name="name">name of sender (object or avatar)</param>
108 /// <param name="id">key of sender (object or avatar)</param>
109 /// <param name="msg">msg to sent</param>
110 void DeliverMessage(ChatTypeEnum type, int channel, string name, UUID id, string msg);
111  
112 /// <summary>
113 /// Delivers the message to a specified object in the region.
114 /// </summary>
115 /// <param name='target'>
116 /// Target.
117 /// </param>
118 /// <param name='channel'>
119 /// Channel.
120 /// </param>
121 /// <param name='name'>
122 /// Name.
123 /// </param>
124 /// <param name='id'>
125 /// Identifier.
126 /// </param>
127 /// <param name='msg'>
128 /// Message.
129 /// </param>
130 void DeliverMessageTo(UUID target, int channel, Vector3 pos, string name, UUID id, string msg);
131  
132 /// <summary>
133 /// Are there any listen events ready to be dispatched?
134 /// </summary>
135 /// <returns>boolean indication</returns>
136 bool HasMessages();
137  
138 /// <summary>
139 /// Pop the first availlable listen event from the queue
140 /// </summary>
141 /// <returns>ListenerInfo with filter filled in</returns>
142 IWorldCommListenerInfo GetNextMessage();
143  
144 void ListenControl(UUID itemID, int handle, int active);
145 void ListenRemove(UUID itemID, int handle);
146 void DeleteListener(UUID itemID);
147 Object[] GetSerializationData(UUID itemID);
148 void CreateFromData(uint localID, UUID itemID, UUID hostID,
149 Object[] data);
150 }
151 }