Class: Redis::Client

Inherits:
Object
  • Object
show all
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,
  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

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/redis/client.rb', line 88

def initialize(options = {})
  @options = _parse_options(options)
  @reconnect = true
  @logger = @options[:logger]
  @connection = nil
  @command_map = {}

  @pending_reads = 0

  @connector =
    if !@options[:sentinels].nil?
      Connector::Sentinel.new(@options)
    elsif options.include?(:connector) && options[:connector].respond_to?(:new)
      options.delete(:connector).new(@options)
    else
      Connector.new(@options)
    end
end

Instance Attribute Details

#command_map ⇒ Object (readonly)

Returns the value of attribute command_map.



86
87
88
 
# File 'lib/redis/client.rb', line 86

def command_map
  @command_map
end

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



85
86
87
 
# File 'lib/redis/client.rb', line 85

def connection
  @connection
end

#logger ⇒ Object

Returns the value of attribute logger.



84
85
86
 
# File 'lib/redis/client.rb', line 84

def logger
  @logger
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



34
35
36
 
# File 'lib/redis/client.rb', line 34

def options
  @options
end

Instance Method Details

#call(command) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/redis/client.rb', line 130

def call(command)
  reply = process([command]) { read }
  raise reply if reply.is_a?(CommandError)

  if block_given?
    yield reply
  else
    reply
  end
end

#call_loop(command, timeout = 0) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/redis/client.rb', line 141

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 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/redis/client.rb', line 165

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 



184
185
186
187
188
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
 
# File 'lib/redis/client.rb', line 184

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 



224
225
226
227
228
229
230
 
# File 'lib/redis/client.rb', line 224

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 



232
233
234
 
# File 'lib/redis/client.rb', line 232

def call_without_timeout(command, &blk)
  call_with_timeout(command, 0, &blk)
end

#connect ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/redis/client.rb', line 107

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
    call [:client, :setname, @options[:id]] if @options[:id]
    @connector.check(self)
  end

  self
end

#connect_timeout ⇒ Object 



56
57
58
 
# File 'lib/redis/client.rb', line 56

def connect_timeout
  @options[:connect_timeout]
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
 
# File 'lib/redis/client.rb', line 253

def connected?
  !!(connection && connection.connected?)
end

#db ⇒ Object 



68
69
70
 
# File 'lib/redis/client.rb', line 68

def db
  @options[:db]
end

#db=(db) ⇒ Object 



72
73
74
 
# File 'lib/redis/client.rb', line 72

def db=(db)
  @options[:db] = db.to_i
end

#disconnect ⇒ Object Also known as: close 



257
258
259
 
# File 'lib/redis/client.rb', line 257

def disconnect
  connection.disconnect if connected?
end

#driver ⇒ Object 



76
77
78
 
# File 'lib/redis/client.rb', line 76

def driver
  @options[:driver]
end

#host ⇒ Object 



40
41
42
 
# File 'lib/redis/client.rb', line 40

def host
  @options[:host]
end

#id ⇒ Object 



122
123
124
 
# File 'lib/redis/client.rb', line 122

def id
  @options[:id] || "redis://#{location}/#{db}"
end

#inherit_socket? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/redis/client.rb', line 80

def inherit_socket?
  @options[:inherit_socket]
end

#io ⇒ Object 



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/redis/client.rb', line 267

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 



126
127
128
 
# File 'lib/redis/client.rb', line 126

def location
  path || "#{host}:#{port}"
end

#password ⇒ Object 



64
65
66
 
# File 'lib/redis/client.rb', line 64

def password
  @options[:password]
end

#path ⇒ Object 



48
49
50
 
# File 'lib/redis/client.rb', line 48

def path
  @options[:path]
end

#port ⇒ Object 



44
45
46
 
# File 'lib/redis/client.rb', line 44

def port
  @options[:port]
end

#process(commands) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/redis/client.rb', line 236

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 



278
279
280
281
282
283
284
 
# File 'lib/redis/client.rb', line 278

def read
  io do
    value = connection.read
    @pending_reads -= 1
    value
  end
end

#read_timeout ⇒ Object 



52
53
54
 
# File 'lib/redis/client.rb', line 52

def read_timeout
  @options[:read_timeout]
end

#reconnect ⇒ Object 



262
263
264
265
 
# File 'lib/redis/client.rb', line 262

def reconnect
  disconnect
  connect
end

#scheme ⇒ Object 



36
37
38
 
# File 'lib/redis/client.rb', line 36

def scheme
  @options[:scheme]
end

#timeout ⇒ Object 



60
61
62
 
# File 'lib/redis/client.rb', line 60

def timeout
  @options[:read_timeout]
end

#with_reconnect(val = true) ⇒ Object 



311
312
313
314
315
316
 
# File 'lib/redis/client.rb', line 311

def with_reconnect(val = true)
  original, @reconnect = @reconnect, val
  yield
ensure
  @reconnect = original
end

#with_socket_timeout(timeout) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/redis/client.rb', line 293

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 



318
319
320
 
# File 'lib/redis/client.rb', line 318

def without_reconnect(&blk)
  with_reconnect(false, &blk)
end

#without_socket_timeout(&blk) ⇒ Object 



307
308
309
 
# File 'lib/redis/client.rb', line 307

def without_socket_timeout(&blk)
  with_socket_timeout(0, &blk)
end

#write(command) ⇒ Object 



286
287
288
289
290
291
 
# File 'lib/redis/client.rb', line 286

def write(command)
  io do
    @pending_reads += 1
    connection.write(command)
  end
end