class

Kiq::Node

Inherits Kiq::Batch::Callback::OnComplete < Kiq::Batch::Callback::CallbackHandler < Kiq::Job < Reference < Object

own methods first, then ancestors (e.g. Kiq::Node subclasses inherit #perform) a splat perform accepts any arity; cap the dispatch a splat perform accepts zero args

Constants

REGISTRY = {} of String => ::Kiq::Node.class

Compile-time registry: "pipeline_name/node_name" -> node class, used by PipelineCallback to trigger the next node.

Class methods

clear
Source
drain
Source
jobs

--- testing API (Sidekiq::Job::ClassMethods) --------------------

Source
perform_async

--- enqueue API --------------------------------------------------- NB: a typed splat in Crystal requires >= 1 argument, so the common zero-arg form gets its own overload.

Source
perform_async(*args : Kiq::Arg) : String | Nil | Bool
Source
perform_at(interval : Float64 | Int32 | Time::Span | Time) : String | Nil
Source
perform_at(interval : Float64 | Int32 | Time::Span | Time, *args : Kiq::Arg) : String | Nil
Source
perform_bulk(args : Array(Array(Kiq::Arg))) : Array(String | Nil)
Source
perform_in(interval : Float64 | Int32 | Time::Span | Time) : String | Nil
Source
perform_in(interval : Float64 | Int32 | Time::Span | Time, *args : Kiq::Arg) : String | Nil
Source
perform_inline

Explicit inline execution, no queue (1:1 with perform_inline).

Source
perform_inline(*args : Kiq::Arg) : Bool
Source
perform_one
Source

Instance methods

__kiq_perform(args : Array(Kiq::Arg)) : Nil
Source
batch
Source
custom_notifiers(prefix : String, msg : String) : Nil
Source
desc
Source
execute(args : Array(Kiq::Arg)) : Nil
Source
kiq_queue
Source
mark_node_started!

Pipeline tracking hook — overridden by Kiq::PipelineTracking.

Source
next_node
Source
node_name
Source
notify_all(msg : String) : Nil
Source
observer
Source
on_complete(status : Kiq::Batch::FinalStatusSnapshot, options : Hash(String, Arg)) : Nil
Source
perform(*args) : Nil
Source
pipeline_name
Source
pipeline_tracking?

Registered when the node class tracks pipeline status.

Source
save_bid_to_database!(bid : String | Nil) : Nil
Source

Macros

desc(str)
Source
execute
Source
next_node(node)
Source