From 6993a26ba599ae38dc6f66332980657d5621987a Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Fri, 15 Jun 2012 00:40:12 +0100
Subject: Get rid of some unnecessary null checks in
 RegionApplicationBase.StartupSpecific() - a constructor can never return
 null.

Also adds some method doc to MainServer
---
 OpenSim/Framework/Servers/MainServer.cs | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

(limited to 'OpenSim/Framework/Servers/MainServer.cs')

diff --git a/OpenSim/Framework/Servers/MainServer.cs b/OpenSim/Framework/Servers/MainServer.cs
index b8ab8d9..ea972ef 100644
--- a/OpenSim/Framework/Servers/MainServer.cs
+++ b/OpenSim/Framework/Servers/MainServer.cs
@@ -47,20 +47,43 @@ namespace OpenSim.Framework.Servers
             set { instance = value; }
         }
 
-        public static IHttpServer GetHttpServer(uint port)
+        /// <summary>
+        /// Add an already started HTTP server to the collection of known servers.
+        /// </summary>
+        /// <param name='server'></param>
+        public static void AddHttpServer(BaseHttpServer server)
         {
-            return GetHttpServer(port,null);
+            m_Servers.Add(server.Port, server);
         }
 
-        public static void AddHttpServer(BaseHttpServer server)
+        /// <summary>
+        /// Get the default http server or an http server for a specific port.
+        /// </summary>
+        /// <remarks>
+        /// If the requested HTTP server doesn't already exist then a new one is instantiated and started.
+        /// </remarks>
+        /// <returns></returns>
+        /// <param name='port'>If 0 then the default HTTP server is returned.</param>
+        public static IHttpServer GetHttpServer(uint port)
         {
-            m_Servers.Add(server.Port, server);
+            return GetHttpServer(port, null);
         }
 
+        /// <summary>
+        /// Get the default http server, an http server for a specific port
+        /// and/or an http server bound to a specific address
+        /// </summary>
+        /// <remarks>
+        /// If the requested HTTP server doesn't already exist then a new one is instantiated and started.
+        /// </remarks>
+        /// <returns></returns>
+        /// <param name='port'>If 0 then the default HTTP server is returned.</param>
+        /// <param name='ipaddr'>A specific IP address to bind to.  If null then the default IP address is used.</param>
         public static IHttpServer GetHttpServer(uint port, IPAddress ipaddr)
         {
             if (port == 0)
                 return Instance;
+            
             if (instance != null && port == Instance.Port)
                 return Instance;
 
-- 
cgit v1.1