From df82eaf8a83d5e09080a042b715a01d66d548dfb Mon Sep 17 00:00:00 2001
From: Teravus Ovares <teravus@gmail.com>
Date: Tue, 6 Jan 2009 01:10:26 +0000
Subject: [PATCH] * Mjnor: Clarified comment to ensure that people are aware of
 how to end the recursive calls

---
 .../Avatar/InstantMessage/MessageTransferModule.cs     | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/OpenSim/Region/Environment/Modules/Avatar/InstantMessage/MessageTransferModule.cs b/OpenSim/Region/Environment/Modules/Avatar/InstantMessage/MessageTransferModule.cs
index afd6a4ccce..353cc77f37 100644
--- a/OpenSim/Region/Environment/Modules/Avatar/InstantMessage/MessageTransferModule.cs
+++ b/OpenSim/Region/Environment/Modules/Avatar/InstantMessage/MessageTransferModule.cs
@@ -419,8 +419,16 @@ namespace OpenSim.Region.Environment.Modules.Avatar.InstantMessage
 
         /// <summary>
         /// Recursive SendGridInstantMessage over XMLRPC method.
+        /// This is called from within a dedicated thread.
+        /// The first time this is called, prevRegionHandle will be 0 Subsequent times this is called from 
+        /// itself, prevRegionHandle will be the last region handle that we tried to send.
+        /// If the handles are the same, we look up the user's location using the grid.
+        /// If the handles are still the same, we end.  The send failed.
         /// </summary>
-        /// <param name="prevRegionHandle"></param>
+        /// <param name="prevRegionHandle">
+        /// Pass in 0 the first time this method is called.  It will be called recursively with the last 
+        /// regionhandle tried
+        /// </param>
         protected virtual void SendGridInstantMessageViaXMLRPCAsync(GridInstantMessage im, MessageResultNotification result, ulong prevRegionHandle)
         {
             UUID toAgentID = new UUID(im.toAgentID);