module Resque
Constants
- Version
Attributes
Set the after_continue proc.
Set the #after_pause proc.
Set or retrieve the current logger object
Public Class Methods
# File lib/resque.rb, line 58 def self.config @config ||= Config.new end
# File lib/resque.rb, line 54 def self.config=(options = {}) @config = Config.new(options) end
# File lib/resque.rb, line 62 def self.configure yield config end
Public Instance Methods
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 register a hook. Call with no arguments to return all registered hooks.
# File lib/resque.rb, line 156 def after_fork(&block) block ? register_hook(:after_fork, block) : hooks(:after_fork) end
Register an #after_fork proc.
# File lib/resque.rb, line 161 def after_fork=(block) register_hook(:after_fork, block) end
The `after_pause` hook will be run in the parent process after the worker has paused (via SIGCONT).
# File lib/resque.rb, line 176 def after_pause(&block) block ? register_hook(:after_pause, block) : hooks(:after_pause) end
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 register a hook. Call with no arguments to return all registered hooks.
# File lib/resque.rb, line 126 def before_first_fork(&block) block ? register_hook(:before_first_fork, block) : hooks(:before_first_fork) end
Register a #before_first_fork proc.
# File lib/resque.rb, line 131 def before_first_fork=(block) register_hook(:before_first_fork, block) end
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 register a hook. Call with no arguments to return all registered hooks.
# File lib/resque.rb, line 141 def before_fork(&block) block ? register_hook(:before_fork, block) : hooks(:before_fork) end
Register a #before_fork proc.
# File lib/resque.rb, line 146 def before_fork=(block) register_hook(:before_fork, block) end
The `before_pause` hook will be run in the parent process before the worker has paused processing (via pause_processing or SIGUSR2).
# File lib/resque.rb, line 167 def before_pause(&block) block ? register_hook(:before_pause, block) : hooks(:before_pause) end
Given a string, returns a Ruby object.
# File lib/resque.rb, line 38 def decode(object) return unless object begin if MultiJson.respond_to?(:dump) && MultiJson.respond_to?(:load) MultiJson.load object else MultiJson.decode object end rescue ::MultiJson::DecodeError => e raise Helpers::DecodeException, e.message, e.backtrace end end
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.
# File lib/resque.rb, line 353 def dequeue(klass, *args) # Perform before_dequeue hooks. Don't perform dequeue if any hook returns false before_hooks = Plugin.before_dequeue_hooks(klass).collect do |hook| klass.send(hook, *args) end return if before_hooks.any? { |result| result == false } destroyed = Job.destroy(queue_from_class(klass), klass, *args) Plugin.after_dequeue_hooks(klass).each do |hook| klass.send(hook, *args) end destroyed end
Given a Ruby object, returns a string suitable for storage in a queue.
# File lib/resque.rb, line 29 def encode(object) if MultiJson.respond_to?(:dump) && MultiJson.respond_to?(:load) MultiJson.dump object else MultiJson.encode object end end
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`
Returns true if the job was queued, nil if the job was rejected by a before_enqueue hook.
This method is considered part of the `stable` API.
# File lib/resque.rb, line 297 def enqueue(klass, *args) enqueue_to(queue_from_class(klass), klass, *args) end
Just like `enqueue` but allows you to specify the queue you want to use. Runs hooks.
`queue` should be the String name of the queue you're targeting.
Returns true if the job was queued, nil if the job was rejected by a before_enqueue hook.
This method is considered part of the `stable` API.
# File lib/resque.rb, line 310 def enqueue_to(queue, klass, *args) # Perform before_enqueue hooks. Don't perform enqueue if any hook returns false before_hooks = Plugin.before_enqueue_hooks(klass).collect do |hook| klass.send(hook, *args) end return nil if before_hooks.any? { |result| result == false } Job.create(queue, klass, *args) Plugin.after_enqueue_hooks(klass).each do |hook| klass.send(hook, *args) end return true end
Returns a hash, similar to redis-rb's info, of interesting stats.
# File lib/resque.rb, line 429 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 => Resque.redis.llen(:failed).to_i, :servers => [redis_id], :environment => ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development' } end
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.
# File lib/resque.rb, line 444 def keys redis.keys("*").map do |key| key.sub("#{redis.namespace}:", '') end end
Does the dirty work of fetching a range of items from a Redis list and converting them into Ruby objects.
# File lib/resque.rb, line 247 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
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)
# File lib/resque.rb, line 241 def peek(queue, start = 0, count = 1) list_range("queue:#{queue}", start, count) end
Pops a job off a queue. Queue name should be a string.
Returns a Ruby object.
# File lib/resque.rb, line 223 def pop(queue) decode redis.lpop("queue:#{queue}") end
Pushes a job onto a queue. Queue name should be a string and the item should be any JSON-able Ruby object.
Resque works generally expect the `item` to be a hash with the following keys:
class - The String name of the job to run. args - An Array of arguments to pass the job. Usually passed via `class.to_class.perform(*args)`.
Example
Resque.push('archive', :class => 'Archive', :args => [ 35, 'tar' ])
Returns nothing
# File lib/resque.rb, line 213 def push(queue, item) redis.pipelined do watch_queue(queue) redis.rpush "queue:#{queue}", encode(item) end end
Given a class, try to extrapolate an appropriate queue based on a class instance variable or `queue` method.
# File lib/resque.rb, line 371 def queue_from_class(klass) klass.instance_variable_get(:@queue) || (klass.respond_to?(:queue) and klass.queue) end
Returns an array of all known Resque queues as strings.
# File lib/resque.rb, line 258 def queues Array(redis.smembers(:queues)) end
Returns the current Redis connection. If none has been created, will create a new one.
# File lib/resque.rb, line 99 def redis return @redis if @redis self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379" self.redis end
Accepts:
1. A 'hostname:port' String 2. A 'hostname:port:db' String (to select the Redis db) 3. A 'hostname:port/namespace' String (to set the Redis namespace) 4. A Redis URL String 'redis://host:port' 5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`, or `Redis::Namespace`. 6. An Hash of a redis connection {:host => 'localhost', :port => 6379, :db => 0}
# File lib/resque.rb, line 74 def redis=(server) case server when String if server =~ /redis\:\/\// redis = Redis.connect(:url => server, :thread_safe => true) else server, namespace = server.split('/', 2) host, port, db = server.split(':') redis = Redis.new(:host => host, :port => port, :thread_safe => true, :db => db) end namespace ||= :resque @redis = Redis::Namespace.new(namespace, :redis => redis) when Redis::Namespace @redis = server when Hash @redis = Redis::Namespace.new(:resque, :redis => Redis.new(server)) else @redis = Redis::Namespace.new(:resque, :redis => server) end end
# File lib/resque.rb, line 105 def redis_id # support 1.x versions of redis-rb if redis.respond_to?(:server) redis.server elsif redis.respond_to?(:nodes) # distributed redis.nodes.map { |n| n.id }.join(', ') else redis.client.id end end
Given a queue name, completely deletes the queue.
# File lib/resque.rb, line 263 def remove_queue(queue) redis.pipelined do redis.srem(:queues, queue.to_s) redis.del("queue:#{queue}") end end
A shortcut to unregister_worker useful for command line tool
# File lib/resque.rb, line 419 def remove_worker(worker_id) worker = Resque::Worker.find(worker_id) worker.unregister_worker end
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.
# File lib/resque.rb, line 381 def reserve(queue) Job.reserve(queue) end
Returns an integer representing the size of a queue. Queue name should be a string.
# File lib/resque.rb, line 229 def size(queue) redis.llen("queue:#{queue}").to_i end
# File lib/resque.rb, line 183 def to_s "Resque Client connected to #{redis_id}" end
Validates if the given klass could be a valid Resque job
If no queue can be inferred this method will raise a `Resque::NoQueueError`
If given klass is nil this method will raise a `Resque::NoClassError`
# File lib/resque.rb, line 390 def validate(klass, queue = nil) queue ||= queue_from_class(klass) if !queue raise NoQueueError.new("Jobs must be placed onto a queue.") end if klass.to_s.empty? raise NoClassError.new("Jobs must be given a class.") end end
Used internally to keep track of which queues we've created. Don't call this directly.
# File lib/resque.rb, line 272 def watch_queue(queue) redis.sadd(:queues, queue.to_s) end
A shortcut to Resque::Worker.all
# File lib/resque.rb, line 408 def workers Worker.all end
A shortcut to Resque::Worker.working
# File lib/resque.rb, line 413 def working Worker.working end
Private Instance Methods
Clear all hooks given a hook name.
# File lib/resque.rb, line 467 def clear_hooks(name) @hooks && @hooks[name] = [] end
Retrieve all hooks of a given name.
# File lib/resque.rb, line 472 def hooks(name) (@hooks && @hooks[name]) || [] end
Register a new proc as a hook. If the block is nil this is the equivalent of removing all hooks of the given name.
`name` is the hook that the block should be registered with.
# File lib/resque.rb, line 456 def register_hook(name, block) return clear_hooks(name) if block.nil? @hooks ||= {} @hooks[name] ||= [] block = Array(block) @hooks[name].concat(block) end