aboutsummaryrefslogtreecommitdiffstats
path: root/activejob
diff options
context:
space:
mode:
authorKingsleyKelly <kingsley.kelly@gmail.com>2015-04-06 22:42:13 +0100
committerKingsleyKelly <kingsley.kelly@gmail.com>2015-04-06 22:50:06 +0100
commit94b1aff2a4c0dc2eeceed2a17f3e0f94821b3684 (patch)
treef3a40e4c362c0fe03c61e1379c82d5ebf30bcc88 /activejob
parent9040699aed64a725cc66461d63f794abc2f13afc (diff)
downloadrails-94b1aff2a4c0dc2eeceed2a17f3e0f94821b3684.tar.gz
rails-94b1aff2a4c0dc2eeceed2a17f3e0f94821b3684.tar.bz2
rails-94b1aff2a4c0dc2eeceed2a17f3e0f94821b3684.zip
[ci skip] Adds rdoc for priority explaining what the labels in the table means.
Diffstat (limited to 'activejob')
-rw-r--r--activejob/lib/active_job/queue_adapters.rb16
1 files changed, 16 insertions, 0 deletions
diff --git a/activejob/lib/active_job/queue_adapters.rb b/activejob/lib/active_job/queue_adapters.rb
index b3d91dc562..ac514c55e2 100644
--- a/activejob/lib/active_job/queue_adapters.rb
+++ b/activejob/lib/active_job/queue_adapters.rb
@@ -29,6 +29,22 @@ module ActiveJob
# | Active Job Inline | No | Yes | N/A | N/A | N/A | N/A |
# | Active Job | Yes | Yes | Yes | No | No | No |
#
+ # ==== 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 class object.
+ #
+ # Queue: The adapter configures priority per queue, not on the class object.
+ #
+ # 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: This adapter is configured in such a way that priority does not apply.
+ #
+ #
+ #
# 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