class

ActiveJob::Base

Inherits Reference < Object

Constructors

deserialize(h : Hash(String, ArgValue)) : Base

new(*args)

Class methods

__discard_classes

__retry_rule

default_priority

default_queue_name

DSL defaults (overridden by the macros above).

find_job_class(name : String) : Base.class | Nil

Job-class lookup by name (compile-time registry) — used by recurring tasks and anything resolving class_name strings.

perform_later(*args)

perform_now(*args)

set(*, queue : String | Nil = nil, priority : Int32 | Nil = nil, wait : ActiveSupport::Duration | Time::Span | Nil = nil, wait_until : Time | Nil = nil) : JobSetter

set(queue:, wait:, wait_until:, priority:) — like Rails' JobSetter.

Instance methods

__build_record

__cb_after_enqueue

__cb_after_perform

__cb_around_enqueue(inner : Proc(Nil)) : Nil

__cb_around_perform(inner : Proc(Nil)) : Nil

__cb_before_enqueue

__cb_before_perform

No-op callback defaults.

__enqueue(scheduled : Time | Nil) : Nil

__execute_now

__perform_result

Last perform's return value (perform_now returns it). Limited to scalars — Crystal needs a closed type for the ivar; documented deviation from Ruby's "anything".

__perform_result=(__perform_result : String | Int32 | Int64 | Float64 | Bool | Nil)

Last perform's return value (perform_now returns it). Limited to scalars — Crystal needs a closed type for the ivar; documented deviation from Ruby's "anything".

arguments

arguments=(arguments : Array(ArgValue))

exception_executions

exception_executions=(exception_executions : Hash(String, Int32))

executions

executions=(executions : Int32)

job_id

perform_now

Instance form: run this (possibly deserialized) job with its own stored arguments — Base.deserialize(data).perform_now.

priority

priority=(p : Int32 | Nil)

provider_job_id

provider_job_id=(provider_job_id : String | Nil)

queue_name

queue_name=(name : String)

scheduled_at

scheduled_at=(scheduled_at : Time | Nil)

serialize

successfully_enqueued?

Macros

after_enqueue

after_perform

around_enqueue

around_perform

before_enqueue

before_perform

discard_on(klass)

queue_as(name)

queue_with_priority(value)

retry_on(klass, attempts = 3, wait = 3.seconds)