Document RedisConfig options, change DefaultConnectTimeout to -1 to be consistent with Send/Receive Timeout

Author: mythz

src/ServiceStack.Redis/RedisConfig.cs

@@ -13,32 +13,79 @@ public class RedisConfig
         public const int DefaultPortSentinel = 26379;
         public const string DefaultHost = "localhost";
 
+        /// <summary>
+        /// Factory used to Create `RedisClient` instances
+        /// </summary>
         public static Func<RedisEndpoint, RedisClient> ClientFactory = c =>
         {
             Interlocked.Increment(ref RedisState.TotalClientsCreated);
             return new RedisClient(c);
         };
 
-        public static int DefaultConnectTimeout = 0;
+        /// <summary>
+        /// The default RedisClient Socket ConnectTimeout (default -1, None)
+        /// </summary>
+        public static int DefaultConnectTimeout = -1;
+
+        /// <summary>
+        /// The default RedisClient Socket SendTimeout (default -1, None)
+        /// </summary>
         public static int DefaultSendTimeout = -1;
+
+        /// <summary>
+        /// The default RedisClient Socket ReceiveTimeout (default -1, None)
+        /// </summary>
         public static int DefaultReceiveTimeout = -1;
-        public static int DefaultRetryTimeout = 3 * 1000;
+
+        /// <summary>
+        /// Default Idle TimeOut before a connection is considered to be stale (default 240 secs)
+        /// </summary>
         public static int DefaultIdleTimeOutSecs = 240;
+
+        /// <summary>
+        /// The default RetryTimeout for auto retry of failed operations (default 3000ms)
+        /// </summary>
+        public static int DefaultRetryTimeout = 3 * 1000;
+
+        /// <summary>
+        /// The BackOff multiplier failed Auto Retries starts from (default 10ms)
+        /// </summary>
         public static int BackOffMultiplier = 10;
 
+        /// <summary>
+        /// The Byte Buffer Size to combine Redis Operations within (default 1450 bytes)
+        /// </summary>
         public static int BufferLength = 1450;
 
+        /// <summary>
+        /// The Byte Buffer Size for Operations to use a byte buffer pool (default 500kb)
+        /// </summary>
         public static int BufferPoolMaxSize = 500000;
 
+        /// <summary>
+        /// Whether Connections to Master hosts should be verified they're still master instances (default true)
+        /// </summary>
         public static bool VerifyMasterConnections = true;
 
+        /// <summary>
+        /// The ConnectTimeout on clients used to find the next available host (default 200ms)
+        /// </summary>
         public static int HostLookupTimeoutMs = 200;
 
-        //Skip ServerVersion Checks by specifying Min Version number, e.g: 2.8.12 => 2812, 2.9.1 => 2910
+        /// <summary>
+        /// Skip ServerVersion Checks by specifying Min Version number, e.g: 2.8.12 => 2812, 2.9.1 => 2910
+        /// </summary>
         public static int? AssumeServerVersion;
 
+        /// <summary>
+        /// How long to hold deactivated clients for before disposing their connection (default 1 min)
+        /// Dispose of deactivated Clients immediately with TimeSpan.Zero
+        /// </summary>
         public static TimeSpan DeactivatedClientsExpiry = TimeSpan.FromMinutes(1);
 
+        /// <summary>
+        /// Whether Debug Logging should log detailed Redis operations (default false)
+        /// </summary>
         public static bool DisableVerboseLogging = false;
 
         //Example at: http://msdn.microsoft.com/en-us/library/office/dd633677(v=exchg.80).aspx 
@@ -52,7 +99,7 @@ public static void Reset()
         {
             RedisStats.Reset();
 
-            DefaultConnectTimeout = 0;
+            DefaultConnectTimeout = -1;
             DefaultSendTimeout = -1;
             DefaultReceiveTimeout = -1;
             DefaultRetryTimeout = 3 * 1000;

src/ServiceStack.Redis/RedisNativeClient_Utils.cs

@@ -76,7 +76,7 @@ private void Connect()
             };
             try
             {
-                if (ConnectTimeout == 0)
+                if (ConnectTimeout <= 0)
                 {
                     socket.Connect(Host, Port);
                 }