Rename timeout option to read_timeout, update README, #437

Author: mperham

README.md

@@ -40,7 +40,8 @@ listening on `localhost`, port 6379. If you need to connect to a remote
 server or a different port, try:
 
 ```ruby
-redis = Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+redis = Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15,
+                  :read_timeout => 1, :connect_timeout => 1)
 ```
 
 You can also specify connection options as an URL:

lib/redis/client.rb

@@ -11,7 +11,7 @@ class Client
       :host => "127.0.0.1",
       :port => 6379,
       :path => nil,
-      :timeout => 5.0,
+      :read_timeout => 5.0,
       :connect_timeout => 5.0,
       :password => nil,
       :db => 0,
@@ -42,8 +42,16 @@ def path
       @options[:path]
     end
 
+    def read_timeout
+      @options[:read_timeout]
+    end
+
+    def connect_timeout
+      @options[:connect_timeout]
+    end
+
     def timeout
-      @options[:timeout]
+      @options[:read_timeout]
     end
 
     def password
@@ -422,11 +430,16 @@ def _parse_options(options)
         options[:port] = options[:port].to_i
       end
 
-      options[:timeout] = options[:timeout].to_f
+      if options.has_key?(:timeout)
+        options[:read_timeout] ||= options[:timeout]
+        options[:connect_timeout] ||= options[:timeout]
+      end
+
+      options[:read_timeout] = options[:read_timeout].to_f
       options[:connect_timeout] = if options[:connect_timeout]
         options[:connect_timeout].to_f
       else
-        options[:timeout]
+        options[:read_timeout]
       end
 
       options[:db] = options[:db].to_i

lib/redis/connection/hiredis.rb

@@ -18,7 +18,7 @@ def self.connect(config)
         end
 
         instance = new(connection)
-        instance.timeout = config[:timeout]
+        instance.timeout = config[:read_timeout]
         instance
       rescue Errno::ETIMEDOUT
         raise TimeoutError

lib/redis/connection/synchrony.rb

@@ -81,7 +81,7 @@ def self.connect(config)
         raise Errno::ECONNREFUSED if Fiber.yield == :refused
 
         instance = new(conn)
-        instance.timeout = config[:timeout]
+        instance.timeout = config[:read_timeout]
         instance
       end