Class: Redis::Client
- Inherits:
-
Object
- Object
- Redis::Client
- Defined in:
- lib/redis/client.rb
Defined Under Namespace
Classes: Connector
Constant Summary collapse
- DEFAULTS =
{ :url => lambda { ENV["REDIS_URL"] }, :scheme => "redis", :host => "127.0.0.1", :port => 6379, :path => nil, :timeout => 5.0, :connect_timeout => 5.0, :password => nil, :db => 0, :driver => nil, :id => nil, :tcp_keepalive => 0, :reconnect_attempts => 1, :inherit_socket => false }
Instance Attribute Summary collapse
-
#command_map ⇒ Object
readonly
Returns the value of attribute command_map.
-
#connection ⇒ Object
readonly
Returns the value of attribute connection.
-
#logger ⇒ Object
Returns the value of attribute logger.
Instance Method Summary collapse
- #call(command, &block) ⇒ Object
- #call_loop(command) ⇒ Object
- #call_pipeline(pipeline) ⇒ Object
- #call_pipelined(commands) ⇒ Object
- #call_with_timeout(command, timeout, &blk) ⇒ Object
- #call_without_timeout(command, &blk) ⇒ Object
- #connect ⇒ Object
- #connected? ⇒ Boolean
- #db ⇒ Object
- #db=(db) ⇒ Object
- #disconnect ⇒ Object
- #driver ⇒ Object
- #host ⇒ Object
- #id ⇒ Object
- #inherit_socket? ⇒ Boolean
-
#initialize(options = {}) ⇒ Client
constructor
A new instance of Client.
- #io ⇒ Object
- #location ⇒ Object
- #options ⇒ Object
- #password ⇒ Object
- #path ⇒ Object
- #port ⇒ Object
- #process(commands) ⇒ Object
- #read ⇒ Object
- #reconnect ⇒ Object
- #scheme ⇒ Object
- #timeout ⇒ Object
- #with_reconnect(val = true) ⇒ Object
- #with_socket_timeout(timeout) ⇒ Object
- #without_reconnect(&blk) ⇒ Object
- #without_socket_timeout(&blk) ⇒ Object
- #write(command) ⇒ Object
Constructor Details
#initialize(options = {}) ⇒ Client
Returns a new instance of Client.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/redis/client.rb', line 73 def initialize( = {}) @options = () @reconnect = true @logger = @options[:logger] @connection = nil @command_map = {} @pending_reads = 0 if .include?(:sentinels) @connector = Connector::Sentinel.new(@options) else @connector = Connector.new(@options) end end |
Instance Attribute Details
#command_map ⇒ Object (readonly)
Returns the value of attribute command_map.
71 72 73 |
# File 'lib/redis/client.rb', line 71 def command_map @command_map end |
#connection ⇒ Object (readonly)
Returns the value of attribute connection.
70 71 72 |
# File 'lib/redis/client.rb', line 70 def connection @connection end |
#logger ⇒ Object
Returns the value of attribute logger.
69 70 71 |
# File 'lib/redis/client.rb', line 69 def logger @logger end |
Instance Method Details
#call(command, &block) ⇒ Object
111 112 113 114 115 116 117 118 119 120 |
# File 'lib/redis/client.rb', line 111 def call(command, &block) reply = process([command]) { read } raise reply if reply.is_a?(CommandError) if block block.call(reply) else reply end end |
#call_loop(command) ⇒ Object
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/redis/client.rb', line 122 def call_loop(command) error = nil result = without_socket_timeout do process([command]) do loop do reply = read if reply.is_a?(CommandError) error = reply break else yield reply end end end end # Raise error when previous block broke out of the loop. raise error if error # Result is set to the value that the provided block used to break. result end |
#call_pipeline(pipeline) ⇒ Object
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/redis/client.rb', line 146 def call_pipeline(pipeline) with_reconnect pipeline.with_reconnect? do begin pipeline.finish(call_pipelined(pipeline.commands)).tap do self.db = pipeline.db if pipeline.db end rescue ConnectionError => e return nil if pipeline.shutdown? # Assume the pipeline was sent in one piece, but execution of # SHUTDOWN caused none of the replies for commands that were executed # prior to it from coming back around. raise e end end end |
#call_pipelined(commands) ⇒ Object
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/redis/client.rb', line 162 def call_pipelined(commands) return [] if commands.empty? # The method #ensure_connected (called from #process) reconnects once on # I/O errors. To make an effort in making sure that commands are not # executed more than once, only allow reconnection before the first reply # has been read. When an error occurs after the first reply has been # read, retrying would re-execute the entire pipeline, thus re-issuing # already successfully executed commands. To circumvent this, don't retry # after the first reply has been read successfully. result = Array.new(commands.size) reconnect = @reconnect begin process(commands) do result[0] = read @reconnect = false (commands.size - 1).times do |i| result[i + 1] = read end end ensure @reconnect = reconnect end result end |
#call_with_timeout(command, timeout, &blk) ⇒ Object
193 194 195 196 197 198 199 |
# File 'lib/redis/client.rb', line 193 def call_with_timeout(command, timeout, &blk) with_socket_timeout(timeout) do call(command, &blk) end rescue ConnectionError retry end |
#call_without_timeout(command, &blk) ⇒ Object
201 202 203 |
# File 'lib/redis/client.rb', line 201 def call_without_timeout(command, &blk) call_with_timeout(command, 0, &blk) end |
#connect ⇒ Object
89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/redis/client.rb', line 89 def connect @pid = Process.pid # Don't try to reconnect when the connection is fresh with_reconnect(false) do establish_connection call [:auth, password] if password call [:select, db] if db != 0 @connector.check(self) end self end |
#connected? ⇒ Boolean
222 223 224 |
# File 'lib/redis/client.rb', line 222 def connected? !! (connection && connection.connected?) end |
#db ⇒ Object
53 54 55 |
# File 'lib/redis/client.rb', line 53 def db @options[:db] end |
#db=(db) ⇒ Object
57 58 59 |
# File 'lib/redis/client.rb', line 57 def db=(db) @options[:db] = db.to_i end |
#disconnect ⇒ Object
226 227 228 |
# File 'lib/redis/client.rb', line 226 def disconnect connection.disconnect if connected? end |
#driver ⇒ Object
61 62 63 |
# File 'lib/redis/client.rb', line 61 def driver @options[:driver] end |
#host ⇒ Object
33 34 35 |
# File 'lib/redis/client.rb', line 33 def host @options[:host] end |
#id ⇒ Object
103 104 105 |
# File 'lib/redis/client.rb', line 103 def id @options[:id] || "redis://#{location}/#{db}" end |
#inherit_socket? ⇒ Boolean
65 66 67 |
# File 'lib/redis/client.rb', line 65 def inherit_socket? @options[:inherit_socket] end |
#io ⇒ Object
235 236 237 238 239 240 241 242 243 244 |
# File 'lib/redis/client.rb', line 235 def io yield rescue TimeoutError => e1 # Add a message to the exception without destroying the original stack e2 = TimeoutError.new("Connection timed out") e2.set_backtrace(e1.backtrace) raise e2 rescue Errno::ECONNRESET, Errno::EPIPE, Errno::ECONNABORTED, Errno::EBADF, Errno::EINVAL => e raise ConnectionError, "Connection lost (%s)" % [e.class.name.split("::").last] end |
#location ⇒ Object
107 108 109 |
# File 'lib/redis/client.rb', line 107 def location path || "#{host}:#{port}" end |
#options ⇒ Object
25 26 27 |
# File 'lib/redis/client.rb', line 25 def Marshal.load(Marshal.dump(@options)) end |
#password ⇒ Object
49 50 51 |
# File 'lib/redis/client.rb', line 49 def password @options[:password] end |
#path ⇒ Object
41 42 43 |
# File 'lib/redis/client.rb', line 41 def path @options[:path] end |
#port ⇒ Object
37 38 39 |
# File 'lib/redis/client.rb', line 37 def port @options[:port] end |
#process(commands) ⇒ Object
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/redis/client.rb', line 205 def process(commands) logging(commands) do ensure_connected do commands.each do |command| if command_map[command.first] command = command.dup command[0] = command_map[command.first] end write(command) end yield if block_given? end end end |
#read ⇒ Object
246 247 248 249 250 251 252 |
# File 'lib/redis/client.rb', line 246 def read io do value = connection.read @pending_reads -= 1 value end end |
#reconnect ⇒ Object
230 231 232 233 |
# File 'lib/redis/client.rb', line 230 def reconnect disconnect connect end |
#scheme ⇒ Object
29 30 31 |
# File 'lib/redis/client.rb', line 29 def scheme @options[:scheme] end |
#timeout ⇒ Object
45 46 47 |
# File 'lib/redis/client.rb', line 45 def timeout @options[:timeout] end |
#with_reconnect(val = true) ⇒ Object
276 277 278 279 280 281 282 283 |
# File 'lib/redis/client.rb', line 276 def with_reconnect(val=true) begin original, @reconnect = @reconnect, val yield ensure @reconnect = original end end |
#with_socket_timeout(timeout) ⇒ Object
261 262 263 264 265 266 267 268 269 270 |
# File 'lib/redis/client.rb', line 261 def with_socket_timeout(timeout) connect unless connected? begin connection.timeout = timeout yield ensure connection.timeout = self.timeout if connected? end end |
#without_reconnect(&blk) ⇒ Object
285 286 287 |
# File 'lib/redis/client.rb', line 285 def without_reconnect(&blk) with_reconnect(false, &blk) end |
#without_socket_timeout(&blk) ⇒ Object
272 273 274 |
# File 'lib/redis/client.rb', line 272 def without_socket_timeout(&blk) with_socket_timeout(0, &blk) end |
#write(command) ⇒ Object
254 255 256 257 258 259 |
# File 'lib/redis/client.rb', line 254 def write(command) io do @pending_reads += 1 connection.write(command) end end |