Module: Resque::Plugins::Status::ClassMethods
- Defined in:
- lib/resque/plugins/status.rb
Instance Method Summary collapse
-
#create(options = {}) ⇒ Object
Create is the primary method for adding jobs to the queue.
-
#dequeue(klass, uuid) ⇒ Object
Removes a job of type <tt>klass<tt> from the queue.
-
#enqueue(klass, options = {}) ⇒ Object
Adds a job of type <tt>klass<tt> to the queue with <tt>options<tt>.
-
#enqueue_to(queue, klass, options = {}) ⇒ Object
Adds a job of type <tt>klass<tt> to a specified queue with <tt>options<tt>.
-
#name ⇒ Object
used when displaying the Job in the resque-web UI and identifiyng the job type by status.
-
#perform(uuid = nil, options = {}) ⇒ Object
This is the method called by Resque::Worker when processing jobs.
-
#queue ⇒ Object
The default queue is :statused, this can be ovveridden in the specific job class to put the jobs on a specific worker queue.
-
#scheduled(queue, klass, *args) ⇒ Object
Wrapper API to forward a Resque::Job creation API call into a Resque::Plugins::Status call.
Instance Method Details
#create(options = {}) ⇒ Object
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 #{['num']}"
end
end
job_id = ExampleJob.create(:num => 100)
92 93 94 |
# File 'lib/resque/plugins/status.rb', line 92 def create( = {}) self.enqueue(self, ) end |
#dequeue(klass, uuid) ⇒ Object
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)
124 125 126 127 |
# File 'lib/resque/plugins/status.rb', line 124 def dequeue(klass, uuid) status = Resque::Plugins::Status::Hash.get(uuid) Resque.dequeue(klass, uuid, status.) end |
#enqueue(klass, options = {}) ⇒ Object
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.
100 101 102 |
# File 'lib/resque/plugins/status.rb', line 100 def enqueue(klass, = {}) self.enqueue_to(Resque.queue_from_class(klass) || queue, klass, ) end |
#enqueue_to(queue, klass, options = {}) ⇒ Object
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.
108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/resque/plugins/status.rb', line 108 def enqueue_to(queue, klass, = {}) uuid = Resque::Plugins::Status::Hash.generate_uuid Resque::Plugins::Status::Hash.create uuid, :options => if Resque.enqueue_to(queue, klass, uuid, ) uuid else Resque::Plugins::Status::Hash.remove(uuid) nil end end |
#name ⇒ Object
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
70 71 72 |
# File 'lib/resque/plugins/status.rb', line 70 def name self.to_s end |
#perform(uuid = nil, options = {}) ⇒ Object
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.
134 135 136 137 138 139 |
# File 'lib/resque/plugins/status.rb', line 134 def perform(uuid=nil, = {}) uuid ||= Resque::Plugins::Status::Hash.generate_uuid instance = new(uuid, ) instance.safe_perform! instance end |
#queue ⇒ Object
The default queue is :statused, this can be ovveridden in the specific job class to put the jobs on a specific worker queue
62 63 64 |
# File 'lib/resque/plugins/status.rb', line 62 def queue :statused end |
#scheduled(queue, klass, *args) ⇒ Object
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
144 145 146 |
# File 'lib/resque/plugins/status.rb', line 144 def scheduled(queue, klass, *args) self.enqueue_to(queue, self, *args) end |