Class: Redis::Client

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

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
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



58
59
60
61
62
63
64
 
# File 'lib/redis/client.rb', line 58

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

Instance Attribute Details

#command_map ⇒ Object (readonly)

Returns the value of attribute command_map.



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

def command_map
  @command_map
end

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



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

def connection
  @connection
end

#logger ⇒ Object

Returns the value of attribute logger.



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

def logger
  @logger
end

Instance Method Details

#call(command, &block) ⇒ Object 



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

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 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/redis/client.rb', line 94

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 



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

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 



134
135
136
137
138
139
140
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 134

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 



165
166
167
168
169
170
171
 
# File 'lib/redis/client.rb', line 165

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 



173
174
175
 
# File 'lib/redis/client.rb', line 173

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

#connect ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/redis/client.rb', line 66

def connect
  @pid = Process.pid

  establish_connection
  call [:auth, password] if password
  call [:select, db] if db != 0
  self
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/redis/client.rb', line 194

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

#db ⇒ Object 



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

def db
  @options[:db]
end

#db=(db) ⇒ Object 



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

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

#disconnect ⇒ Object 



198
199
200
 
# File 'lib/redis/client.rb', line 198

def disconnect
  connection.disconnect if connected?
end

#host ⇒ Object 



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

def host
  @options[:host]
end

#id ⇒ Object 



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

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

#io ⇒ Object 



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

def io
  yield
rescue TimeoutError
  raise TimeoutError, "Connection timed out"
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 



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

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

#password ⇒ Object 



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

def password
  @options[:password]
end

#path ⇒ Object 



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

def path
  @options[:path]
end

#port ⇒ Object 



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

def port
  @options[:port]
end

#process(commands) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/redis/client.rb', line 177

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 



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

def read
  io do
    connection.read
  end
end

#reconnect ⇒ Object 



202
203
204
205
 
# File 'lib/redis/client.rb', line 202

def reconnect
  disconnect
  connect
end

#scheme ⇒ Object 



22
23
24
 
# File 'lib/redis/client.rb', line 22

def scheme
  @options[:scheme]
end

#timeout ⇒ Object 



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

def timeout
  @options[:timeout]
end

#with_reconnect(val = true) ⇒ Object 



242
243
244
245
246
247
248
249
 
# File 'lib/redis/client.rb', line 242

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

#with_socket_timeout(timeout) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/redis/client.rb', line 227

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 



251
252
253
 
# File 'lib/redis/client.rb', line 251

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

#without_socket_timeout(&blk) ⇒ Object 



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

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

#write(command) ⇒ Object 



221
222
223
224
225
 
# File 'lib/redis/client.rb', line 221

def write(command)
  io do
    connection.write(command)
  end
end