aboutsummaryrefslogtreecommitdiffstats
path: root/activejob/lib/active_job/queue_adapter.rb
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2014-09-26 11:10:06 -0600
committermo khan <mo@mokhan.ca>2014-10-02 10:57:30 -0600
commitbc6421c9eff09fee31d4947d2cc6ddc580314de0 (patch)
treeb60143567122b7b368886baa916df38d1a23da10 /activejob/lib/active_job/queue_adapter.rb
parent7b740f31cc6f88fe20a51eb7da1468082e6fdb5a (diff)
downloadrails-bc6421c9eff09fee31d4947d2cc6ddc580314de0.tar.gz
rails-bc6421c9eff09fee31d4947d2cc6ddc580314de0.tar.bz2
rails-bc6421c9eff09fee31d4947d2cc6ddc580314de0.zip
Add documentation on Active Job.
This adds documentation for the Active Job API. It includes documentation on how to configure the queue_adapter, and how to create new jobs. It adds links to the various other sections of the Active Job documentation.
Diffstat (limited to 'activejob/lib/active_job/queue_adapter.rb')
-rw-r--r--activejob/lib/active_job/queue_adapter.rb7
1 files changed, 5 insertions, 2 deletions
diff --git a/activejob/lib/active_job/queue_adapter.rb b/activejob/lib/active_job/queue_adapter.rb
index fb54aec75e..4bd28522ab 100644
--- a/activejob/lib/active_job/queue_adapter.rb
+++ b/activejob/lib/active_job/queue_adapter.rb
@@ -2,12 +2,15 @@ require 'active_job/queue_adapters/inline_adapter'
require 'active_support/core_ext/string/inflections'
module ActiveJob
- module QueueAdapter
+ module QueueAdapter #:nodoc:
extend ActiveSupport::Concern
module ClassMethods
mattr_reader(:queue_adapter) { ActiveJob::QueueAdapters::InlineAdapter }
+ # Specify the backend queue provider. The default queue adapter
+ # is the :inline queue. See QueueAdapters for more
+ # information.
def queue_adapter=(name_or_adapter)
@@queue_adapter = \
case name_or_adapter
@@ -26,4 +29,4 @@ module ActiveJob
end
end
end
-end \ No newline at end of file
+end