Class: ActiveJob::QueueAdapters::SuckerPunchAdapter
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
AbstractAdapter
|
|
Instance Chain:
self,
AbstractAdapter
|
|
Inherits: |
ActiveJob::QueueAdapters::AbstractAdapter
|
Defined in: | activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb |
Overview
Sucker Punch adapter for Active Job
Sucker Punch is a single-process Ruby asynchronous processing library. This reduces the cost of hosting on a service like Heroku along with the memory footprint of having to maintain additional jobs if hosting on a dedicated server. All queues can run within a single application (e.g. Rails, Sinatra, etc.) process.
Read more about Sucker Punch here.
To use Sucker Punch set the queue_adapter config to :sucker_punch
.
Rails.application.config.active_job.queue_adapter = :sucker_punch
Instance Method Summary
- #check_adapter
- #enqueue(job) Internal use only
- #enqueue_at(job, timestamp) Internal use only
AbstractAdapter
- Inherited
Instance Method Details
#check_adapter
[ GitHub ]# File 'activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb', line 21
def check_adapter ActiveJob.deprecator.warn <<~MSG.squish The `sucker_punch` adapter is deprecated and will be removed in Rails 8.1. Please use the `async` adapter instead. MSG end
#enqueue(job)
This method is for internal use only.
[ GitHub ]
# File 'activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb', line 28
def enqueue(job) # :nodoc: if JobWrapper.respond_to?(:perform_async) # sucker_punch 2.0 API JobWrapper.perform_async job.serialize else # sucker_punch 1.0 API JobWrapper.new.async.perform job.serialize end end
#enqueue_at(job, timestamp)
This method is for internal use only.
[ GitHub ]
# File 'activejob/lib/active_job/queue_adapters/sucker_punch_adapter.rb', line 38
def enqueue_at(job, ) # :nodoc: if JobWrapper.respond_to?(:perform_in) delay = - Time.current.to_f JobWrapper.perform_in delay, job.serialize else raise NotImplementedError, "sucker_punch 1.0 does not support `enqueue_at`. Please upgrade to version ~> 2.0.0 to enable this behavior." end end