clockwerk-opensim – Blame information for rev 1
?pathlinks?
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 OpenSim.Framework; |
||
29 | |||
30 | namespace OpenSim.Region.Framework.Interfaces |
||
31 | { |
||
32 | public delegate void MessageResultNotification(bool success); |
||
33 | public delegate void UndeliveredMessage(GridInstantMessage im); |
||
34 | |||
35 | public interface IMessageTransferModule |
||
36 | { |
||
37 | event UndeliveredMessage OnUndeliveredMessage; |
||
38 | |||
39 | /// <summary> |
||
40 | /// Attempt to send an instant message to a given destination. |
||
41 | /// </summary> |
||
42 | /// <remarks> |
||
43 | /// If the message cannot be delivered for any reason, this will be signalled on the OnUndeliveredMessage |
||
44 | /// event. result(false) will also be called if the message cannot be delievered unless the type is |
||
45 | /// InstantMessageDialog.MessageFromAgent. For successful message delivery, result(true) is called. |
||
46 | /// </remarks> |
||
47 | /// <param name="im"></param> |
||
48 | /// <param name="result"></param> |
||
49 | void SendInstantMessage(GridInstantMessage im, MessageResultNotification result); |
||
50 | |||
51 | /// <summary> |
||
52 | /// Appropriately handle a known undeliverable message without attempting a send. |
||
53 | /// </summary> |
||
54 | /// <remarks> |
||
55 | /// Essentially, this invokes the OnUndeliveredMessage event. |
||
56 | /// </remarks> |
||
57 | /// <param name="im"></param> |
||
58 | /// <param name="result"></param> |
||
59 | void HandleUndeliverableMessage(GridInstantMessage im, MessageResultNotification result); |
||
60 | } |
||
61 | } |