diff options
author | Justin Clark-Casey (justincc) | 2014-05-12 23:49:37 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2014-05-12 23:49:37 +0100 |
commit | 484aa72ff893df31d7f0ecc186039905ceee7f24 (patch) | |
tree | 7ff07cfe0b62ab2fdf05daf2d0d7dcdf958852b9 /OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs | |
parent | Make offline IM delivery to URL (pre recent Addons code) have a 10 second rat... (diff) | |
download | opensim-SC_OLD-484aa72ff893df31d7f0ecc186039905ceee7f24.zip opensim-SC_OLD-484aa72ff893df31d7f0ecc186039905ceee7f24.tar.gz opensim-SC_OLD-484aa72ff893df31d7f0ecc186039905ceee7f24.tar.bz2 opensim-SC_OLD-484aa72ff893df31d7f0ecc186039905ceee7f24.tar.xz |
minor: Add some method doc to IMessageTransferModule
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs b/OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs index 379c769..290b826 100644 --- a/OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs +++ b/OpenSim/Region/Framework/Interfaces/IMessageTransferModule.cs | |||
@@ -36,8 +36,26 @@ namespace OpenSim.Region.Framework.Interfaces | |||
36 | { | 36 | { |
37 | event UndeliveredMessage OnUndeliveredMessage; | 37 | event UndeliveredMessage OnUndeliveredMessage; |
38 | 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> | ||
39 | void SendInstantMessage(GridInstantMessage im, MessageResultNotification result); | 49 | void SendInstantMessage(GridInstantMessage im, MessageResultNotification result); |
40 | 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> | ||
41 | void HandleUndeliverableMessage(GridInstantMessage im, MessageResultNotification result); | 59 | void HandleUndeliverableMessage(GridInstantMessage im, MessageResultNotification result); |
42 | } | 60 | } |
43 | } | 61 | } |