Class: Redis::Client
- Inherits:
-
Object
- Object
- Redis::Client
- Defined in:
- lib/redis/client.rb
Defined Under Namespace
Classes: Connector
Constant Summary collapse
- DEFAULTS =
Defaults are also used for converting string keys to symbols.
{ url: -> { ENV["REDIS_URL"] }, scheme: "redis", host: "127.0.0.1", port: 6379, path: nil, read_timeout: nil, write_timeout: nil, connect_timeout: nil, timeout: 5.0, username: nil, password: nil, db: 0, driver: nil, id: nil, tcp_keepalive: 0, reconnect_attempts: 1, reconnect_delay: 0, reconnect_delay_max: 0.5, inherit_socket: false, logger: nil, sentinels: nil, role: nil }.freeze
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.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
- #call(command) ⇒ Object
- #call_loop(command, timeout = 0) ⇒ Object
- #call_pipeline(pipeline) ⇒ Object
- #call_pipelined(pipeline) ⇒ Object
- #call_with_timeout(command, timeout, &blk) ⇒ Object
- #call_without_timeout(command, &blk) ⇒ Object
- #connect ⇒ Object
- #connect_timeout ⇒ Object
- #connected? ⇒ Boolean
- #db ⇒ Object
- #db=(db) ⇒ Object
- #disconnect ⇒ Object (also: #close)
- #driver ⇒ Object
- #host ⇒ Object
- #id ⇒ Object
- #inherit_socket? ⇒ Boolean
-
#initialize(options = {}) ⇒ Client
constructor
A new instance of Client.
- #io ⇒ Object
- #location ⇒ Object
- #password ⇒ Object
- #path ⇒ Object
- #port ⇒ Object
- #process(commands) ⇒ Object
- #read ⇒ Object
- #read_timeout ⇒ Object
- #reconnect ⇒ Object
- #scheme ⇒ Object
- #timeout ⇒ Object
- #username ⇒ 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.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/redis/client.rb', line 93 def initialize( = {}) @options = () @reconnect = true @logger = @options[:logger] @connection = nil @command_map = {} @pending_reads = 0 @connector = if !@options[:sentinels].nil? Connector::Sentinel.new(@options) elsif .include?(:connector) && [:connector].respond_to?(:new) .delete(:connector).new(@options) else Connector.new(@options) end end |
Instance Attribute Details
#command_map ⇒ Object (readonly)
Returns the value of attribute command_map.
91 92 93 |
# File 'lib/redis/client.rb', line 91 def command_map @command_map end |
#connection ⇒ Object (readonly)
Returns the value of attribute connection.
90 91 92 |
# File 'lib/redis/client.rb', line 90 def connection @connection end |
#logger ⇒ Object
Returns the value of attribute logger.
89 90 91 |
# File 'lib/redis/client.rb', line 89 def logger @logger end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
35 36 37 |
# File 'lib/redis/client.rb', line 35 def @options end |
Instance Method Details
#call(command) ⇒ Object
135 136 137 138 139 140 141 142 143 144 |
# File 'lib/redis/client.rb', line 135 def call(command) reply = process([command]) { read } raise reply if reply.is_a?(CommandError) if block_given? && reply != 'QUEUED' yield reply else reply end end |
#call_loop(command, timeout = 0) ⇒ Object
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/redis/client.rb', line 146 def call_loop(command, timeout = 0) error = nil result = with_socket_timeout(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
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/redis/client.rb', line 170 def call_pipeline(pipeline) return [] if pipeline.futures.empty? with_reconnect pipeline.with_reconnect? do begin pipeline.finish(call_pipelined(pipeline)).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(pipeline) ⇒ Object
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/redis/client.rb', line 189 def call_pipelined(pipeline) return [] if pipeline.futures.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. commands = pipeline.commands result = Array.new(commands.size) reconnect = @reconnect begin exception = nil process(commands) do pipeline.timeouts.each_with_index do |timeout, i| reply = if timeout with_socket_timeout(timeout) { read } else read end result[i] = reply @reconnect = false exception = reply if exception.nil? && reply.is_a?(CommandError) end end raise exception if exception ensure @reconnect = reconnect end result end |
#call_with_timeout(command, timeout, &blk) ⇒ Object
229 230 231 232 233 234 235 |
# File 'lib/redis/client.rb', line 229 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
237 238 239 |
# File 'lib/redis/client.rb', line 237 def call_without_timeout(command, &blk) call_with_timeout(command, 0, &blk) end |
#connect ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/redis/client.rb', line 112 def connect @pid = Process.pid # Don't try to reconnect when the connection is fresh with_reconnect(false) do establish_connection call [:auth, username, password].compact if username || password call [:select, db] if db != 0 call [:client, :setname, @options[:id]] if @options[:id] @connector.check(self) end self end |
#connect_timeout ⇒ Object
57 58 59 |
# File 'lib/redis/client.rb', line 57 def connect_timeout @options[:connect_timeout] end |
#connected? ⇒ Boolean
258 259 260 |
# File 'lib/redis/client.rb', line 258 def connected? !!(connection && connection.connected?) end |
#db ⇒ Object
73 74 75 |
# File 'lib/redis/client.rb', line 73 def db @options[:db] end |
#db=(db) ⇒ Object
77 78 79 |
# File 'lib/redis/client.rb', line 77 def db=(db) @options[:db] = db.to_i end |
#disconnect ⇒ Object Also known as: close
262 263 264 |
# File 'lib/redis/client.rb', line 262 def disconnect connection.disconnect if connected? end |
#driver ⇒ Object
81 82 83 |
# File 'lib/redis/client.rb', line 81 def driver @options[:driver] end |
#host ⇒ Object
41 42 43 |
# File 'lib/redis/client.rb', line 41 def host @options[:host] end |
#id ⇒ Object
127 128 129 |
# File 'lib/redis/client.rb', line 127 def id @options[:id] || "redis://#{location}/#{db}" end |
#inherit_socket? ⇒ Boolean
85 86 87 |
# File 'lib/redis/client.rb', line 85 def inherit_socket? @options[:inherit_socket] end |
#io ⇒ Object
272 273 274 275 276 277 278 279 280 281 |
# File 'lib/redis/client.rb', line 272 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
131 132 133 |
# File 'lib/redis/client.rb', line 131 def location path || "#{host}:#{port}" end |
#password ⇒ Object
69 70 71 |
# File 'lib/redis/client.rb', line 69 def password @options[:password] end |
#path ⇒ Object
49 50 51 |
# File 'lib/redis/client.rb', line 49 def path @options[:path] end |
#port ⇒ Object
45 46 47 |
# File 'lib/redis/client.rb', line 45 def port @options[:port] end |
#process(commands) ⇒ Object
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/redis/client.rb', line 241 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
283 284 285 286 287 288 289 |
# File 'lib/redis/client.rb', line 283 def read io do value = connection.read @pending_reads -= 1 value end end |
#read_timeout ⇒ Object
53 54 55 |
# File 'lib/redis/client.rb', line 53 def read_timeout @options[:read_timeout] end |
#reconnect ⇒ Object
267 268 269 270 |
# File 'lib/redis/client.rb', line 267 def reconnect disconnect connect end |
#scheme ⇒ Object
37 38 39 |
# File 'lib/redis/client.rb', line 37 def scheme @options[:scheme] end |
#timeout ⇒ Object
61 62 63 |
# File 'lib/redis/client.rb', line 61 def timeout @options[:read_timeout] end |
#username ⇒ Object
65 66 67 |
# File 'lib/redis/client.rb', line 65 def username @options[:username] end |
#with_reconnect(val = true) ⇒ Object
316 317 318 319 320 321 |
# File 'lib/redis/client.rb', line 316 def with_reconnect(val = true) original, @reconnect = @reconnect, val yield ensure @reconnect = original end |
#with_socket_timeout(timeout) ⇒ Object
298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/redis/client.rb', line 298 def with_socket_timeout(timeout) connect unless connected? original = @options[:read_timeout] begin connection.timeout = timeout @options[:read_timeout] = timeout # for reconnection yield ensure connection.timeout = self.timeout if connected? @options[:read_timeout] = original end end |
#without_reconnect(&blk) ⇒ Object
323 324 325 |
# File 'lib/redis/client.rb', line 323 def without_reconnect(&blk) with_reconnect(false, &blk) end |
#without_socket_timeout(&blk) ⇒ Object
312 313 314 |
# File 'lib/redis/client.rb', line 312 def without_socket_timeout(&blk) with_socket_timeout(0, &blk) end |
#write(command) ⇒ Object
291 292 293 294 295 296 |
# File 'lib/redis/client.rb', line 291 def write(command) io do @pending_reads += 1 connection.write(command) end end |