Class: Redis::Client

Inherits:
Object
  • Object
show all
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,
  :password => nil,
  :db => 0,
  :driver => nil,
  :id => nil,
  :tcp_keepalive => 0,
  :reconnect_attempts => 1,
  :inherit_socket => false
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/redis/client.rb', line 78

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

  @pending_reads = 0

  if options.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.



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

def command_map
  @command_map
end

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



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

def connection
  @connection
end

#logger ⇒ Object

Returns the value of attribute logger.



74
75
76
 
# File 'lib/redis/client.rb', line 74

def logger
  @logger
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



24
25
26
 
# File 'lib/redis/client.rb', line 24

def options
  @options
end

Instance Method Details

#call(command) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/redis/client.rb', line 117

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 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/redis/client.rb', line 128

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 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/redis/client.rb', line 152

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 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/redis/client.rb', line 168

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
    exception = nil

    process(commands) do
      result[0] = read

      @reconnect = false

      (commands.size - 1).times do |i|
        reply = read
        result[i + 1] = reply
        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 



205
206
207
208
209
210
211
 
# File 'lib/redis/client.rb', line 205

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 



213
214
215
 
# File 'lib/redis/client.rb', line 213

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

#connect ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/redis/client.rb', line 94

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 



46
47
48
 
# File 'lib/redis/client.rb', line 46

def connect_timeout
  @options[:connect_timeout]
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/redis/client.rb', line 234

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

#db ⇒ Object 



58
59
60
 
# File 'lib/redis/client.rb', line 58

def db
  @options[:db]
end

#db=(db) ⇒ Object 



62
63
64
 
# File 'lib/redis/client.rb', line 62

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

#disconnect ⇒ Object 



238
239
240
 
# File 'lib/redis/client.rb', line 238

def disconnect
  connection.disconnect if connected?
end

#driver ⇒ Object 



66
67
68
 
# File 'lib/redis/client.rb', line 66

def driver
  @options[:driver]
end

#host ⇒ Object 



30
31
32
 
# File 'lib/redis/client.rb', line 30

def host
  @options[:host]
end

#id ⇒ Object 



109
110
111
 
# File 'lib/redis/client.rb', line 109

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

#inherit_socket? ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/redis/client.rb', line 70

def inherit_socket?
  @options[:inherit_socket]
end

#io ⇒ Object 



247
248
249
250
251
252
253
254
255
256
 
# File 'lib/redis/client.rb', line 247

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 



113
114
115
 
# File 'lib/redis/client.rb', line 113

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

#password ⇒ Object 



54
55
56
 
# File 'lib/redis/client.rb', line 54

def password
  @options[:password]
end

#path ⇒ Object 



38
39
40
 
# File 'lib/redis/client.rb', line 38

def path
  @options[:path]
end

#port ⇒ Object 



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

def port
  @options[:port]
end

#process(commands) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/redis/client.rb', line 217

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 



258
259
260
261
262
263
264
 
# File 'lib/redis/client.rb', line 258

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

#read_timeout ⇒ Object 



42
43
44
 
# File 'lib/redis/client.rb', line 42

def read_timeout
  @options[:read_timeout]
end

#reconnect ⇒ Object 



242
243
244
245
 
# File 'lib/redis/client.rb', line 242

def reconnect
  disconnect
  connect
end

#scheme ⇒ Object 



26
27
28
 
# File 'lib/redis/client.rb', line 26

def scheme
  @options[:scheme]
end

#timeout ⇒ Object 



50
51
52
 
# File 'lib/redis/client.rb', line 50

def timeout
  @options[:read_timeout]
end

#with_reconnect(val = true) ⇒ Object 



288
289
290
291
292
293
294
295
 
# File 'lib/redis/client.rb', line 288

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

#with_socket_timeout(timeout) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/redis/client.rb', line 273

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 



297
298
299
 
# File 'lib/redis/client.rb', line 297

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

#without_socket_timeout(&blk) ⇒ Object 



284
285
286
 
# File 'lib/redis/client.rb', line 284

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

#write(command) ⇒ Object 



266
267
268
269
270
271
 
# File 'lib/redis/client.rb', line 266

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