From ad262444dc7ecc9112c063b2d0e7849d726d7416 Mon Sep 17 00:00:00 2001
From: Justin Clarke Casey <jjustincc@googlemail.com>
Date: Mon, 25 Aug 2008 21:55:44 +0000
Subject: [PATCH] * minor: some logging conformance, code documenting

---
 .../Communications/OGS1/OGS1GridServices.cs   | 26 +++++++++++++++----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/OpenSim/Region/Communications/OGS1/OGS1GridServices.cs b/OpenSim/Region/Communications/OGS1/OGS1GridServices.cs
index 4346ecbe25..abaf74330a 100644
--- a/OpenSim/Region/Communications/OGS1/OGS1GridServices.cs
+++ b/OpenSim/Region/Communications/OGS1/OGS1GridServices.cs
@@ -162,7 +162,8 @@ namespace OpenSim.Region.Communications.OGS1
             {
                 string errorstring = (string) GridRespData["error"];
 
-                Exception e = new Exception(String.Format("Unable to connect to grid at {0}: {1}", serversInfo.GridURL, errorstring));
+                Exception e = new Exception(
+                    String.Format("Unable to connect to grid at {0}: {1}", serversInfo.GridURL, errorstring));
 
                 throw e;
             }
@@ -258,7 +259,10 @@ namespace OpenSim.Region.Communications.OGS1
                         }
                         catch (SocketException e)
                         {
-                            m_log.WarnFormat("RequestNeighbours(): Lookup of neighbour {0} failed!  Not including in neighbours list.  {1}", simIp, e);
+                            m_log.WarnFormat(
+                                "[OGS1 GRID SERVICES]: RequestNeighbours(): Lookup of neighbour {0} failed!  Not including in neighbours list.  {1}", 
+                                simIp, e);
+                            
                             continue;
                         }
 
@@ -1573,6 +1577,13 @@ namespace OpenSim.Region.Communications.OGS1
 
         int timeOut = 10; //10 seconds
 
+        /// <summary>
+        /// Check that a region is available for TCP comms.  This is necessary for .NET remoting between regions.
+        /// </summary>
+        /// <param name="address"></param>
+        /// <param name="port"></param>
+        /// <param name="retry"></param>
+        /// <returns></returns>
         public bool CheckRegion(string address, uint port, bool retry)
         {
             bool available = false;
@@ -1593,7 +1604,8 @@ namespace OpenSim.Region.Communications.OGS1
                 }
                 catch (Exception e)
                 {
-                    m_log.DebugFormat("Callback EndConnect exception: {0}:{1}", e.Message, e.StackTrace);
+                    m_log.DebugFormat(
+                        "[OGS1 GRID SERVICES]: Callback EndConnect exception: {0}:{1}", e.Message, e.StackTrace);
                 }
 
                 s.Close();
@@ -1607,13 +1619,17 @@ namespace OpenSim.Region.Communications.OGS1
             }
             catch (Exception e)
             {
-                m_log.DebugFormat("CheckRegion Socket Setup exception: {0}:{1}", e.Message, e.StackTrace);
+                m_log.DebugFormat(
+                    "[OGS1 GRID SERVICES]: CheckRegion Socket Setup exception: {0}:{1}", e.Message, e.StackTrace);
+                
                 return false;
             }
 
             if (timed_out)
             {
-                m_log.DebugFormat("socket [{0}] timed out ({1}) waiting to obtain a connection.", m_EndPoint, timeOut * 1000);
+                m_log.DebugFormat(
+                    "[OGS1 GRID SERVICES]: socket [{0}] timed out ({1}) waiting to obtain a connection.", 
+                    m_EndPoint, timeOut * 1000);
 
                 if (retry)
                 {