From 484aa72ff893df31d7f0ecc186039905ceee7f24 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 12 May 2014 23:49:37 +0100
Subject: minor: Add some method doc to IMessageTransferModule

---
 .../Framework/Interfaces/IMessageTransferModule.cs     | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'OpenSim/Region/Framework/Interfaces')

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
     {
         event UndeliveredMessage OnUndeliveredMessage;
 
+        /// <summary>
+        /// Attempt to send an instant message to a given destination.
+        /// </summary>
+        /// <remarks>
+        /// If the message cannot be delivered for any reason, this will be signalled on the OnUndeliveredMessage
+        /// event.  result(false) will also be called if the message cannot be delievered unless the type is
+        /// InstantMessageDialog.MessageFromAgent.  For successful message delivery, result(true) is called.
+        /// </remarks>
+        /// <param name="im"></param>
+        /// <param name="result"></param>
         void SendInstantMessage(GridInstantMessage im, MessageResultNotification result);
 
+        /// <summary>
+        /// Appropriately handle a known undeliverable message without attempting a send.
+        /// </summary>
+        /// <remarks>
+        /// Essentially, this invokes the OnUndeliveredMessage event.
+        /// </remarks>
+        /// <param name="im"></param>
+        /// <param name="result"></param>
         void HandleUndeliverableMessage(GridInstantMessage im, MessageResultNotification result);
     }
 }
-- 
cgit v1.1