Module: Resque

Extended by:
Resque
Includes:
Helpers
Included in:
Resque
Defined in:
lib/resque.rb,
lib/resque/job.rb,
lib/resque/stat.rb,
lib/resque/errors.rb,
lib/resque/plugin.rb,
lib/resque/server.rb,
lib/resque/worker.rb,
lib/resque/failure.rb,
lib/resque/helpers.rb,
lib/resque/version.rb,
lib/resque/failure/base.rb,
lib/resque/failure/redis.rb,
lib/resque/failure/hoptoad.rb,
lib/resque/failure/multiple.rb,
lib/resque/server/test_helper.rb

Defined Under Namespace

Modules: Failure, Helpers, Plugin, Stat, TestHelper Classes: DirtyExit, Job, NoClassError, NoQueueError, Server, Worker

Constant Summary collapse

Version = 
VERSION = '1.9.3'

Instance Method Summary collapse

Methods included from Helpers

#classify, #constantize, #decode, #encode

Instance Method Details

#after_fork(&block) ⇒ Object

The ‘after_fork` hook will be run in the child process and is passed the current job. Any changes you make, therefore, will only live as long as the job currently being processed.

Call with a block to set the hook. Call with no arguments to return the hook.



99
100
101
 
# File 'lib/resque.rb', line 99

def after_fork(&block)
  block ? (@after_fork = block) : @after_fork
end

#after_fork=(after_fork) ⇒ Object

Set the after_fork proc.



104
105
106
 
# File 'lib/resque.rb', line 104

def after_fork=(after_fork)
  @after_fork = after_fork
end

#before_first_fork(&block) ⇒ Object

The ‘before_first_fork` hook will be run in the parent process only once, before forking to run the first job. Be careful- any changes you make will be permanent for the lifespan of the worker.

Call with a block to set the hook. Call with no arguments to return the hook.



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

def before_first_fork(&block)
  block ? (@before_first_fork = block) : @before_first_fork
end

#before_first_fork=(before_first_fork) ⇒ Object

Set a proc that will be called in the parent process before the worker forks for the first time.



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

def before_first_fork=(before_first_fork)
  @before_first_fork = before_first_fork
end

#before_fork(&block) ⇒ Object

The ‘before_fork` hook will be run in the parent process before every job, so be careful- any changes you make will be permanent for the lifespan of the worker.

Call with a block to set the hook. Call with no arguments to return the hook.



84
85
86
 
# File 'lib/resque.rb', line 84

def before_fork(&block)
  block ? (@before_fork = block) : @before_fork
end

#before_fork=(before_fork) ⇒ Object

Set the before_fork proc.



89
90
91
 
# File 'lib/resque.rb', line 89

def before_fork=(before_fork)
  @before_fork = before_fork
end

#dequeue(klass, *args) ⇒ Object

This method can be used to conveniently remove a job from a queue. It assumes the class you’re passing it is a real Ruby class (not a string or reference) which either:

a) has a @queue ivar set
b) responds to `queue`

If either of those conditions are met, it will use the value obtained from performing one of the above operations to determine the queue.

If no queue can be inferred this method will raise a ‘Resque::NoQueueError`

If no args are given, this method will dequeue all jobs matching the provided class. See ‘Resque::Job.destroy` for more information.

Returns the number of jobs destroyed.

Example:

# Removes all jobs of class `UpdateNetworkGraph`
Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph)

# Removes all jobs of class `UpdateNetworkGraph` with matching args.
Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph, 'repo:135325')

This method is considered part of the ‘stable` API.



227
228
229
 
# File 'lib/resque.rb', line 227

def dequeue(klass, *args)
  Job.destroy(queue_from_class(klass), klass, *args)
end

#enqueue(klass, *args) ⇒ Object

This method can be used to conveniently add a job to a queue. It assumes the class you’re passing it is a real Ruby class (not a string or reference) which either:

a) has a @queue ivar set
b) responds to `queue`

If either of those conditions are met, it will use the value obtained from performing one of the above operations to determine the queue.

If no queue can be inferred this method will raise a ‘Resque::NoQueueError`

This method is considered part of the ‘stable` API.



196
197
198
 
# File 'lib/resque.rb', line 196

def enqueue(klass, *args)
  Job.create(queue_from_class(klass), klass, *args)
end

#info ⇒ Object

Returns a hash, similar to redis-rb’s #info, of interesting stats.



274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/resque.rb', line 274

def info
  return {
    :pending   => queues.inject(0) { |m,k| m + size(k) },
    :processed => Stat[:processed],
    :queues    => queues.size,
    :workers   => workers.size.to_i,
    :working   => working.size,
    :failed    => Stat[:failed],
    :servers   => [redis_id],
    :environment  => defined?(RAILS_ENV) ? RAILS_ENV : (ENV['RACK_ENV'] || 'development')
  }
end

#keys ⇒ Object

Returns an array of all known Resque keys in Redis. Redis’ KEYS operation is O(N) for the keyspace, so be careful - this can be slow for big databases.



289
290
291
292
293
 
# File 'lib/resque.rb', line 289

def keys
  redis.keys("*").map do |key|
    key.sub("#{redis.namespace}:", '')
  end
end

#list_range(key, start = 0, count = 1) ⇒ Object

Does the dirty work of fetching a range of items from a Redis list and converting them into Ruby objects.



151
152
153
154
155
156
157
158
159
 
# File 'lib/resque.rb', line 151

def list_range(key, start = 0, count = 1)
  if count == 1
    decode redis.lindex(key, start)
  else
    Array(redis.lrange(key, start, start+count-1)).map do |item|
      decode item
    end
  end
end

#peek(queue, start = 0, count = 1) ⇒ Object

Returns an array of items currently queued. Queue name should be a string.

start and count should be integer and can be used for pagination. start is the item to begin, count is how many items to return.

To get the 3rd page of a 30 item, paginatied list one would use:

Resque.peek('my_list', 59, 30)



145
146
147
 
# File 'lib/resque.rb', line 145

def peek(queue, start = 0, count = 1)
  list_range("queue:#{queue}", start, count)
end

#pop(queue) ⇒ Object

Pops a job off a queue. Queue name should be a string.

Returns a Ruby object.



127
128
129
 
# File 'lib/resque.rb', line 127

def pop(queue)
  decode redis.lpop("queue:#{queue}")
end

#push(queue, item) ⇒ Object

Pushes a job onto a queue. Queue name should be a string and the item should be any JSON-able Ruby object.



119
120
121
122
 
# File 'lib/resque.rb', line 119

def push(queue, item)
  watch_queue(queue)
  redis.rpush "queue:#{queue}", encode(item)
end

#queue_from_class(klass) ⇒ Object

Given a class, try to extrapolate an appropriate queue based on a class instance variable or ‘queue` method.



233
234
235
236
 
# File 'lib/resque.rb', line 233

def queue_from_class(klass)
  klass.instance_variable_get(:@queue) ||
    (klass.respond_to?(:queue) and klass.queue)
end

#queues ⇒ Object

Returns an array of all known Resque queues as strings.



162
163
164
 
# File 'lib/resque.rb', line 162

def queues
  Array(redis.smembers(:queues))
end

#redis ⇒ Object

Returns the current Redis connection. If none has been created, will create a new one.



46
47
48
49
50
 
# File 'lib/resque.rb', line 46

def redis
  return @redis if @redis
  self.redis = 'localhost:6379'
  self.redis
end

#redis=(server) ⇒ Object

Accepts:

1. A 'hostname:port' string
2. A 'hostname:port:db' string (to select the Redis db)
3. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
   or `Redis::Namespace`.



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/resque.rb', line 31

def redis=(server)
  if server.respond_to? :split
    host, port, db = server.split(':')
    redis = Redis.new(:host => host, :port => port,
      :thread_safe => true, :db => db)
    @redis = Redis::Namespace.new(:resque, :redis => redis)
  elsif server.respond_to? :namespace=
      @redis = server
  else
    @redis = Redis::Namespace.new(:resque, :redis => server)
  end
end

#redis_id ⇒ Object 



52
53
54
55
56
57
58
59
 
# File 'lib/resque.rb', line 52

def redis_id
  # support 1.x versions of redis-rb
  if redis.respond_to?(:server)
    redis.server
  else
    redis.client.id
  end
end

#remove_queue(queue) ⇒ Object

Given a queue name, completely deletes the queue.



167
168
169
170
 
# File 'lib/resque.rb', line 167

def remove_queue(queue)
  redis.srem(:queues, queue.to_s)
  redis.del("queue:#{queue}")
end

#remove_worker(worker_id) ⇒ Object

A shortcut to unregister_worker useful for command line tool



264
265
266
267
 
# File 'lib/resque.rb', line 264

def remove_worker(worker_id)
  worker = Resque::Worker.find(worker_id)
  worker.unregister_worker
end

#reserve(queue) ⇒ Object

This method will return a ‘Resque::Job` object or a non-true value depending on whether a job can be obtained. You should pass it the precise name of a queue: case matters.

This method is considered part of the ‘stable` API.



243
244
245
 
# File 'lib/resque.rb', line 243

def reserve(queue)
  Job.reserve(queue)
end

#size(queue) ⇒ Object

Returns an integer representing the size of a queue. Queue name should be a string.



133
134
135
 
# File 'lib/resque.rb', line 133

def size(queue)
  redis.llen("queue:#{queue}").to_i
end

#to_s ⇒ Object 



108
109
110
 
# File 'lib/resque.rb', line 108

def to_s
  "Resque Client connected to #{redis_id}"
end

#watch_queue(queue) ⇒ Object

Used internally to keep track of which queues we’ve created. Don’t call this directly.



174
175
176
 
# File 'lib/resque.rb', line 174

def watch_queue(queue)
  redis.sadd(:queues, queue.to_s)
end

#workers ⇒ Object

A shortcut to Worker.all



253
254
255
 
# File 'lib/resque.rb', line 253

def workers
  Worker.all
end

#working ⇒ Object

A shortcut to Worker.working



258
259
260
 
# File 'lib/resque.rb', line 258

def working
  Worker.working
end