From 7d4f5264b5f6151907355ba86a4ec8a9e6e33641 Mon Sep 17 00:00:00 2001 From: KingsleyKelly Date: Thu, 9 Apr 2015 21:14:23 +0100 Subject: [ci skip] Adds documentation explaining table labels for Active Job QueueAdapters table in docs. --- activejob/lib/active_job/queue_adapters.rb | 54 ++++++++++++++++++++++++++---- 1 file changed, 47 insertions(+), 7 deletions(-) diff --git a/activejob/lib/active_job/queue_adapters.rb b/activejob/lib/active_job/queue_adapters.rb index ac514c55e2..f7d88ee551 100644 --- a/activejob/lib/active_job/queue_adapters.rb +++ b/activejob/lib/active_job/queue_adapters.rb @@ -29,27 +29,67 @@ module ActiveJob # | Active Job Inline | No | Yes | N/A | N/A | N/A | N/A | # | Active Job | Yes | Yes | Yes | No | No | No | # - # ==== Priorities + # ==== Async # - # The order in which jobs are processed can be configured differently depending on the adapter. + # Yes: The Queue Adapter runs the jobs in a separate or forked process. # - # Job: Any class inheriting from the adapter may set it's own priority relative to other jobs. Set on the class object. + # No: The job is run in the same process. # - # Queue: The adapter configures priority per queue, not on the class object. + # ==== Queues # - # Yes: Allows the priority of a job to be set on the job object, at the queue level or as a default during configuration. + # Yes: Jobs may set which queue they are run in with queue_as or by using the set method. # - # No: Does not allow the priority of jobs to be configured. + # ==== Delayed # - # N/A: This adapter is configured in such a way that priority does not apply. + # Yes: The adapter lets jobs run in the future through perform_later. # + # (Gem): An additional gem is required to use perform_later with this adapter. # + # No: The adapter will run jobs at the next opportunity and can not use perform_later. + # + # N/A: The adapter does not run in a separate process. # # NOTE: # queue_classic does not support Job scheduling. However you can implement this # yourself or you can use the queue_classic-later gem. See the documentation for # ActiveJob::QueueAdapters::QueueClassicAdapter. # + # ==== Priorities + # + # The order in which jobs are processed can be configured differently depending on the adapter. + # + # Job: Any class inheriting from the adapter may set it's own priority relative to other jobs. Set on the job object. + # + # Queue: The adapter can set the priority of it's queues, when setting a queue with Active Job this will be respected. + # + # Yes: Allows the priority of a job to be set on the job object, at the queue level or as a default during configuration. + # + # No: Does not allow the priority of jobs to be configured. + # + # N/A: The adapter does not run in a separate process. + # + # ==== Timeout + # + # Whether a job will stop after a maximum allotted time. + # + # Job: The timeout for each job is set per instance of the adapter class. + # + # Queue: The adapter allows all jobs on a queue to timeout after a set time. + # + # Global: The adapter is configured that all jobs have a maximum run time. + # + # N/A: This adapter does not run in a separate process. + # + # ==== Retries + # + # Job: The number of retries can be set per instance of the job class. + # + # Yes: The Number of retries can be configured at a global, instance or on the queue. + # Or the adapter may present failed jobs as objects that can be restarted. + # + # Global: The adapter has a global number of retries. + # N/A: The adapter does not run in a separate process. + module QueueAdapters extend ActiveSupport::Autoload -- cgit v1.2.3