Class: Redis::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/redis/client.rb

Defined Under Namespace

Classes: Connector

Constant Summary

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



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

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_mapObject (readonly)

Returns the value of attribute command_map



78
79
80
# File 'lib/redis/client.rb', line 78

def command_map
  @command_map
end

#connectionObject (readonly)

Returns the value of attribute connection



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

def connection
  @connection
end

#loggerObject

Returns the value of attribute logger



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

def logger
  @logger
end

Instance Method Details

#call(command) ⇒ Object



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

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



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

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



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

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



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
204
205
# File 'lib/redis/client.rb', line 170

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



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

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



215
216
217
# File 'lib/redis/client.rb', line 215

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

#connectObject



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

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_timeoutObject



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

def connect_timeout
  @options[:connect_timeout]
end

#connected?Boolean

Returns:

  • (Boolean)


236
237
238
# File 'lib/redis/client.rb', line 236

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

#dbObject



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

def db
  @options[:db]
end

#db=(db) ⇒ Object



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

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

#disconnectObject



240
241
242
# File 'lib/redis/client.rb', line 240

def disconnect
  connection.disconnect if connected?
end

#driverObject



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

def driver
  @options[:driver]
end

#hostObject



32
33
34
# File 'lib/redis/client.rb', line 32

def host
  @options[:host]
end

#idObject



111
112
113
# File 'lib/redis/client.rb', line 111

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

#inherit_socket?Boolean

Returns:

  • (Boolean)


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

def inherit_socket?
  @options[:inherit_socket]
end

#ioObject



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

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

#locationObject



115
116
117
# File 'lib/redis/client.rb', line 115

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

#optionsObject



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

def options
  Marshal.load(Marshal.dump(@options))
end

#passwordObject



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

def password
  @options[:password]
end

#pathObject



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

def path
  @options[:path]
end

#portObject



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

def port
  @options[:port]
end

#process(commands) ⇒ Object



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

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

#readObject



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

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

#read_timeoutObject



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

def read_timeout
  @options[:read_timeout]
end

#reconnectObject



244
245
246
247
# File 'lib/redis/client.rb', line 244

def reconnect
  disconnect
  connect
end

#schemeObject



28
29
30
# File 'lib/redis/client.rb', line 28

def scheme
  @options[:scheme]
end

#timeoutObject



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

def timeout
  @options[:read_timeout]
end

#with_reconnect(val = true) ⇒ Object



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

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

#with_socket_timeout(timeout) ⇒ Object



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

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



299
300
301
# File 'lib/redis/client.rb', line 299

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

#without_socket_timeout(&blk) ⇒ Object



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

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

#write(command) ⇒ Object



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

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