Module: Resque::Plugins::Status::ClassMethods

Defined in:
lib/resque/plugins/status.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) create(options = {})

Create is the primary method for adding jobs to the queue. This would be called on the job class to create a job of that type. Any options passed are passed to the Job instance as a hash of options. It returns the UUID of the job.

Example:

class ExampleJob
  include Resque::Plugins::Status

  def perform
    set_status "Hey I'm a job num #{options['num']}"
  end

end

job_id = ExampleJob.create(:num => 100)


79
80
81
# File 'lib/resque/plugins/status.rb', line 79

def create(options = {})
  self.enqueue(self, options)
end

- (Object) dequeue(klass, uuid)

Removes a job of type <tt>klass<tt> from the queue.

The initially given options are retrieved from the status hash. (Resque needs the options to find the correct queue entry)



111
112
113
114
# File 'lib/resque/plugins/status.rb', line 111

def dequeue(klass, uuid)
  status = Resque::Plugins::Status::Hash.get(uuid)
  Resque.dequeue(klass, uuid, status.options)
end

- (Object) enqueue(klass, options = {})

Adds a job of type <tt>klass<tt> to the queue with <tt>options<tt>.

Returns the UUID of the job if the job was queued, or nil if the job was rejected by a before_enqueue hook.



87
88
89
# File 'lib/resque/plugins/status.rb', line 87

def enqueue(klass, options = {})
  self.enqueue_to(Resque.queue_from_class(klass) || queue, klass, options)
end

- (Object) enqueue_to(queue, klass, options = {})

Adds a job of type <tt>klass<tt> to a specified queue with <tt>options<tt>.

Returns the UUID of the job if the job was queued, or nil if the job was rejected by a before_enqueue hook.



95
96
97
98
99
100
101
102
103
104
105
# File 'lib/resque/plugins/status.rb', line 95

def enqueue_to(queue, klass, options = {})
  uuid = Resque::Plugins::Status::Hash.generate_uuid
  Resque::Plugins::Status::Hash.create uuid, :options => options

  if Resque.enqueue_to(queue, klass, uuid, options)
    uuid
  else
    Resque::Plugins::Status::Hash.remove(uuid)
    nil
  end
end

- (Object) name

used when displaying the Job in the resque-web UI and identifiyng the job type by status. By default this is the name of the job class, but can be ovveridden in the specific job class to present a more user friendly job name



57
58
59
# File 'lib/resque/plugins/status.rb', line 57

def name
  self.to_s
end

- (Object) perform(uuid = nil, options = {})

This is the method called by Resque::Worker when processing jobs. It creates a new instance of the job class and populates it with the uuid and options.

You should not override this method, rahter the perform instance method.



121
122
123
124
125
126
# File 'lib/resque/plugins/status.rb', line 121

def perform(uuid=nil, options = {})
  uuid ||= Resque::Plugins::Status::Hash.generate_uuid
  instance = new(uuid, options)
  instance.safe_perform!
  instance
end

- (Object) queue

The default queue is :statused, this can be ovveridden in the specific job class to put the jobs on a specific worker queue



49
50
51
# File 'lib/resque/plugins/status.rb', line 49

def queue
  :statused
end

- (Object) scheduled(queue, klass, *args)

Wrapper API to forward a Resque::Job creation API call into a Resque::Plugins::Status call. This is needed to be used with resque scheduler github.com/bvandenbos/resque-scheduler



131
132
133
# File 'lib/resque/plugins/status.rb', line 131

def scheduled(queue, klass, *args)
  self.enqueue_to(queue, self, *args)
end