Class: EMJack::Connection

Inherits:
Object
  • Object
show all
Includes:
EM::Deferrable
Defined in:
lib/em-jack/connection.rb

Constant Summary collapse

RETRY_COUNT =
5
@@handlers =
[]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Connection

Returns a new instance of Connection.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/em-jack/connection.rb', line 23

def initialize(opts = {})
  @host = opts[:host] || 'localhost'
  @port = opts[:port] || 11300
  @tube = opts[:tube]

  reset_tube_state

  @data = ""
  @retries = 0
  @in_reserve = false

  @conn = EM::connect(host, port, EMJack::BeanstalkConnection) do |conn|
    conn.client = self
  end

  unless @tube.nil?
    use(@tube)
    watch(@tube)
  end
end

Instance Attribute Details

#hostObject

Returns the value of attribute host.



12
13
14
# File 'lib/em-jack/connection.rb', line 12

def host
  @host
end

#portObject

Returns the value of attribute port.



12
13
14
# File 'lib/em-jack/connection.rb', line 12

def port
  @port
end

Class Method Details

.handlersObject



19
20
21
# File 'lib/em-jack/connection.rb', line 19

def self.handlers
  @@handlers
end

.register_handler(handler) ⇒ Object



14
15
16
17
# File 'lib/em-jack/connection.rb', line 14

def self.register_handler(handler)
  @@handlers ||= []
  @@handlers << handler
end

Instance Method Details

#add_deferrable(&blk) ⇒ Object



277
278
279
280
281
282
283
284
285
286
287
# File 'lib/em-jack/connection.rb', line 277

def add_deferrable(&blk)
  df = EM::DefaultDeferrable.new
  if @error_callback
    df.errback { |err| @error_callback.call(err) }
  end

  df.callback &blk if block_given?

  @deferrables.push(df)
  df
end

#bury(job, pri, &blk) ⇒ Object



172
173
174
175
176
# File 'lib/em-jack/connection.rb', line 172

def bury(job, pri, &blk)
  callback { @conn.send(:bury, job.jobid, pri) }

  add_deferrable(&blk)
end

#connectedObject



235
236
237
238
# File 'lib/em-jack/connection.rb', line 235

def connected
  @retries = 0
  succeed
end

#delete(job, &blk) ⇒ Object



156
157
158
159
160
161
162
# File 'lib/em-jack/connection.rb', line 156

def delete(job, &blk)
  return if job.nil?

  callback { @conn.send(:delete, job.jobid) }

  add_deferrable(&blk)
end

#disconnectedObject



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/em-jack/connection.rb', line 240

def disconnected
  d = @deferrables.dup

  prev_used, prev_watched = reset_tube_state

  set_deferred_status(nil)
  d.each { |df| df.fail(:disconnected) }

  if @retries >= RETRY_COUNT
    if @disconnected_callback
      @disconnected_callback.call
    else
      raise EMJack::Disconnected
    end
  end

  @retries += 1
  EM.add_timer(5) { reconnect(prev_used, prev_watched) }
end

#each_job(timeout = nil, &blk) ⇒ Object



221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/em-jack/connection.rb', line 221

def each_job(timeout = nil, &blk)
  work = Proc.new do
    r = reserve(timeout)
    r.callback do |job|
      blk.call(job)
      EM.next_tick { work.call }
    end
    r.errback do
      EM.next_tick { work.call }
    end
  end
  work.call
end

#extract_body!(bytes, data) ⇒ Object



338
339
340
341
342
343
344
345
346
347
# File 'lib/em-jack/connection.rb', line 338

def extract_body!(bytes, data)
  rem = data[(data.index(/\r\n/) + 2)..-1]
  return [nil, data] if rem.bytesize < bytes

  body = rem[0..(bytes - 1)]
  data = rem[(bytes + 2)..-1]
  data = "" if data.nil?

  [body, data]
end

#fiber!Object



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/em-jack/connection.rb', line 55

def fiber!
  eigen = (class << self
   self
  end)
  eigen.instance_eval do
    %w(use reserve ignore watch peek stats list delete touch bury kick pause release put).each do |meth|
      alias_method :"a#{meth}", meth.to_sym
      define_method(meth.to_sym) do |*args|
        fib = Fiber.current
        ameth = :"a#{meth}"
        p [ameth, *args]
        proc = lambda { |*result| fib.resume(*result) }
        send(ameth, *args, &proc)
        Fiber.yield
      end
    end
  end
end

#ignore(tube, &blk) ⇒ Object



95
96
97
98
99
100
101
102
103
# File 'lib/em-jack/connection.rb', line 95

def ignore(tube, &blk)
  return unless @watched_tubes.include?(tube)

  callback { @conn.send(:ignore, tube) }

  df = add_deferrable(&blk)
  df.callback { @watched_tubes.delete(tube) }
  df
end

#kick(count = 1, &blk) ⇒ Object



178
179
180
181
182
# File 'lib/em-jack/connection.rb', line 178

def kick(count = 1, &blk)
  callback { @conn.send(:kick, count) }

  add_deferrable(&blk)
end

#list(type = nil, &blk) ⇒ Object



144
145
146
147
148
149
150
151
152
153
154
# File 'lib/em-jack/connection.rb', line 144

def list(type = nil, &blk)
  callback {
    case(type)
    when nil then @conn.send(:'list-tubes')
    when :used then @conn.send(:'list-tube-used')
    when :watched then @conn.send(:'list-tubes-watched')
    else raise EMJack::InvalidCommand.new
    end
  }
  add_deferrable(&blk)
end

#on_disconnect(&blk) ⇒ Object



293
294
295
# File 'lib/em-jack/connection.rb', line 293

def on_disconnect(&blk)
  @disconnected_callback = blk
end

#on_error(&blk) ⇒ Object



289
290
291
# File 'lib/em-jack/connection.rb', line 289

def on_error(&blk)
  @error_callback = blk
end

#pause(tube, delay, &blk) ⇒ Object



184
185
186
187
188
# File 'lib/em-jack/connection.rb', line 184

def pause(tube, delay, &blk)
  callback { @conn.send(:'pause-tube', delay) }

  add_deferrable(&blk)
end

#peek(type = nil, &blk) ⇒ Object



117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/em-jack/connection.rb', line 117

def peek(type = nil, &blk)
  callback {
    case(type.to_s)
    when /^\d+$/ then @conn.send(:peek, type)
    when "ready" then @conn.send(:'peek-ready')
    when "delayed" then @conn.send(:'peek-delayed')
    when "buried" then @conn.send(:'peek-buried')
    else raise EMJack::InvalidCommand.new
    end
  }

  add_deferrable(&blk)
end

#put(msg, opts = nil, &blk) ⇒ Object



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/em-jack/connection.rb', line 201

def put(msg, opts = nil, &blk)
  opts = {} if opts.nil?

  pri = (opts[:priority] || 65536).to_i
  pri = 65536 if pri< 0
  pri = 2 ** 32 if pri > (2 ** 32)

  delay = (opts[:delay] || 0).to_i
  delay = 0 if delay < 0

  ttr = (opts[:ttr] || 300).to_i
  ttr = 300 if ttr < 0

  m = msg.to_s

  callback { @conn.send_with_data(:put, m, pri, delay, ttr, m.bytesize) }

  add_deferrable(&blk)
end

#received(data) ⇒ Object



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/em-jack/connection.rb', line 297

def received(data)
  @data << data

  until @data.empty?
    idx = @data.index(/\r\n/)
    break if idx.nil?

    first = @data[0..(idx + 1)]

    df = @deferrables.shift
    handled, skip = false, false
    EMJack::Connection.handlers.each do |h|
      handles, bytes = h.handles?(first)

      next unless handles
      bytes = bytes.to_i

      if bytes > 0
        # if this handler requires us to receive a body make sure we can get
        # the full length of body. If not, we'll go around and wait for more
        # data to be received
        body, @data = extract_body!(bytes, @data) unless bytes <= 0
        break if body.nil?
      else
        @data = @data[(@data.index(/\r\n/) + 2)..-1]
      end

      handled = h.handle(df, first, body, self)
      break if handled
    end

    @deferrables.unshift(df) unless handled

    # not handled means there wasn't enough data to process a complete response
    break unless handled
    next unless @data.index(/\r\n/)

    @data = "" if @data.nil?
  end
end

#reconnect(prev_used, prev_watched) ⇒ Object



260
261
262
263
264
265
266
267
# File 'lib/em-jack/connection.rb', line 260

def reconnect(prev_used, prev_watched)
  @conn.reconnect(@host, @port)

  use(prev_used) if prev_used
  [ prev_watched ].flatten.compact.each do |tube|
    watch(tube)
  end
end

#reconnect!Object



269
270
271
272
273
274
275
# File 'lib/em-jack/connection.rb', line 269

def reconnect!
  @retries = 0

  prev_used, prev_watched = reset_tube_state

  EM.next_tick { reconnect(prev_used, prev_watched) }
end

#release(job, opts = {}, &blk) ⇒ Object



190
191
192
193
194
195
196
197
198
199
# File 'lib/em-jack/connection.rb', line 190

def release(job, opts = {}, &blk)
  return if job.nil?

  pri = (opts[:priority] || 65536).to_i
  delay = (opts[:delay] || 0).to_i

  callback { @conn.send(:release, job.jobid, pri, delay) }

  add_deferrable(&blk)
end

#reserve(timeout = nil, &blk) ⇒ Object



105
106
107
108
109
110
111
112
113
114
115
# File 'lib/em-jack/connection.rb', line 105

def reserve(timeout = nil, &blk)
  callback {
    if timeout
      @conn.send(:'reserve-with-timeout', timeout)
    else
      @conn.send(:reserve)
    end
  }

  add_deferrable(&blk)
end

#reset_tube_stateObject



44
45
46
47
48
49
50
51
52
53
# File 'lib/em-jack/connection.rb', line 44

def reset_tube_state
  prev_used = @used_tube 
  prev_watched = @watched_tubes.dup if @watched_tubes

  @used_tube = 'default'
  @watched_tubes = ['default']
  @deferrables = []

  return [prev_used, prev_watched]
end

#stats(type = nil, val = nil, &blk) ⇒ Object



131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/em-jack/connection.rb', line 131

def stats(type = nil, val = nil, &blk)
  callback {
    case(type)
    when nil then @conn.send(:stats)
    when :tube then @conn.send(:'stats-tube', val)
    when :job then @conn.send(:'stats-job', val.jobid)
    else raise EMJack::InvalidCommand.new
    end
  }

  add_deferrable(&blk)
end

#touch(job, &blk) ⇒ Object



164
165
166
167
168
169
170
# File 'lib/em-jack/connection.rb', line 164

def touch(job, &blk)
  return if job.nil?

  callback { @conn.send(:touch, job.jobid) }

  add_deferrable(&blk)
end

#use(tube, &blk) ⇒ Object



74
75
76
77
78
79
80
81
82
83
# File 'lib/em-jack/connection.rb', line 74

def use(tube, &blk)
  return if @used_tube == tube

  callback {
    @used_tube = tube
    @conn.send(:use, tube)
  }

  add_deferrable(&blk)
end

#watch(tube, &blk) ⇒ Object



85
86
87
88
89
90
91
92
93
# File 'lib/em-jack/connection.rb', line 85

def watch(tube, &blk)
  return if @watched_tubes.include?(tube)

  callback { @conn.send(:watch, tube) }

  df = add_deferrable(&blk)
  df.callback { @watched_tubes.push(tube) }
  df
end