Class: Redis::Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
# File 'lib/redis/client.rb', line 7

def initialize(options = {})
  @path = options[:path]
  if @path.nil?
    @host = options[:host] || "127.0.0.1"
    @port = (options[:port] || 6379).to_i
  end

  @db = (options[:db] || 0).to_i
  @timeout = (options[:timeout] || 5).to_f
  @password = options[:password]
  @logger = options[:logger]
  @reconnect = true
  @connection = Connection.drivers.last.new
end

Instance Attribute Details

#connectionObject (readonly)

Returns the value of attribute connection.



5
6
7
# File 'lib/redis/client.rb', line 5

def connection
  @connection
end

#dbObject

Returns the value of attribute db.



3
4
5
# File 'lib/redis/client.rb', line 3

def db
  @db
end

#hostObject

Returns the value of attribute host.



3
4
5
# File 'lib/redis/client.rb', line 3

def host
  @host
end

#loggerObject

Returns the value of attribute logger.



3
4
5
# File 'lib/redis/client.rb', line 3

def logger
  @logger
end

#passwordObject

Returns the value of attribute password.



3
4
5
# File 'lib/redis/client.rb', line 3

def password
  @password
end

#pathObject

Returns the value of attribute path.



3
4
5
# File 'lib/redis/client.rb', line 3

def path
  @path
end

#portObject

Returns the value of attribute port.



3
4
5
# File 'lib/redis/client.rb', line 3

def port
  @port
end

#timeoutObject

Returns the value of attribute timeout.



4
5
6
# File 'lib/redis/client.rb', line 4

def timeout
  @timeout
end

Instance Method Details

#call(*args) ⇒ Object



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

def call(*args)
  reply = process(args) { read }
  raise reply if reply.is_a?(RuntimeError)
  reply
end

#call_loop(*args) ⇒ Object



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/redis/client.rb', line 43

def call_loop(*args)
  error = nil

  result = without_socket_timeout do
    process(args) do
      loop do
        reply = read
        if reply.is_a?(RuntimeError)
          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_pipelined(commands, options = {}) ⇒ Object



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/redis/client.rb', line 67

def call_pipelined(commands, options = {})
  options[:raise] = true unless options.has_key?(:raise)

  # 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-issueing
  # already succesfully executed commands. To circumvent this, don't retry
  # after the first reply has been read succesfully.
  first = process(*commands) { read }
  error = first if first.is_a?(RuntimeError)

  begin
    remaining = commands.size - 1
    if remaining > 0
      replies = Array.new(remaining) do
        reply = read
        error ||= reply if reply.is_a?(RuntimeError)
        reply
      end
      replies.unshift first
      replies
    else
      replies = [first]
    end
  rescue Exception
    disconnect
    raise
  end

  # Raise first error in pipeline when we should raise.
  raise error if error && options[:raise]

  replies
end

#call_without_timeout(*args) ⇒ Object



104
105
106
107
108
109
110
# File 'lib/redis/client.rb', line 104

def call_without_timeout(*args)
  without_socket_timeout do
    call(*args)
  end
rescue Errno::ECONNRESET
  retry
end

#connectObject



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

def connect
  establish_connection
  call(:auth, @password) if @password
  call(:select, @db) if @db != 0
  self
end

#connected?Boolean

Returns:

  • (Boolean)


124
125
126
# File 'lib/redis/client.rb', line 124

def connected?
  connection.connected?
end

#disconnectObject



128
129
130
# File 'lib/redis/client.rb', line 128

def disconnect
  connection.disconnect if connection.connected?
end

#idObject



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

def id
  "redis://#{location}/#{db}"
end

#locationObject



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

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

#process(*commands) ⇒ Object



112
113
114
115
116
117
118
119
120
121
122
# File 'lib/redis/client.rb', line 112

def process(*commands)
  logging(commands) do
    ensure_connected do
      commands.each do |command|
        connection.write(command)
      end

      yield if block_given?
    end
  end
end

#readObject



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/redis/client.rb', line 137

def read
  begin
    connection.read

  rescue Errno::EAGAIN
    # We want to make sure it reconnects on the next command after the
    # timeout. Otherwise the server may reply in the meantime leaving
    # the protocol in a desync status.
    disconnect

    raise Errno::EAGAIN, "Timeout reading from the socket"

  rescue Errno::ECONNRESET
    raise Errno::ECONNRESET, "Connection lost"
  end
end

#reconnectObject



132
133
134
135
# File 'lib/redis/client.rb', line 132

def reconnect
  disconnect
  connect
end

#without_reconnectObject



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

def without_reconnect
  begin
    original, @reconnect = @reconnect, false
    yield
  ensure
    @reconnect = original
  end
end

#without_socket_timeoutObject



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

def without_socket_timeout
  connect unless connected?

  begin
    self.timeout = 0
    yield
  ensure
    self.timeout = @timeout if connected?
  end
end