abstract class Mosquito::Job

Overview

A Job is a definition for work to be performed. Jobs are pieces of code which run a Task.

Included Modules

Direct Known Subclasses

Defined in:

mosquito/job.cr

Constant Summary

Log = Mosquito::Log.for(self)

Class Method Summary

Instance Method Summary

Macro Summary

Instance methods inherited from module Mosquito::Serializers::Primitives

deserialize_bool(raw : String) : Bool deserialize_bool, deserialize_char(raw : String) : Char deserialize_char, deserialize_float32(raw : String) : Float32 | Nil deserialize_float32, deserialize_float64(raw : String) : Float64 | Nil deserialize_float64, deserialize_int128(raw : String) : Int128 | Nil deserialize_int128, deserialize_int16(raw : String) : Int16 | Nil deserialize_int16, deserialize_int32(raw : String) : Int32 | Nil deserialize_int32, deserialize_int64(raw : String) : Int64 | Nil deserialize_int64, deserialize_int8(raw : String) : Int8 | Nil deserialize_int8, deserialize_string(raw : String) : String | Nil deserialize_string, deserialize_u_int128(raw : String) : UInt128 | Nil deserialize_u_int128, deserialize_u_int16(raw : String) : UInt16 | Nil deserialize_u_int16, deserialize_u_int32(raw : String) : UInt32 | Nil deserialize_u_int32, deserialize_u_int64(raw : String) : UInt64 | Nil deserialize_u_int64, deserialize_u_int8(raw : String) : UInt8 | Nil deserialize_u_int8, serialize_bool(value : Bool) : String serialize_bool, serialize_char(char : Char) : String serialize_char, serialize_float32(value) : String serialize_float32, serialize_float64(value) : String serialize_float64, serialize_int128(value) : String serialize_int128, serialize_int16(value) : String serialize_int16, serialize_int32(value) : String serialize_int32, serialize_int64(value) : String serialize_int64, serialize_int8(value) : String serialize_int8, serialize_string(str : String) : String serialize_string, serialize_symbol(sym : Symbol) : Nil serialize_symbol, serialize_u_int128(value) : String serialize_u_int128, serialize_u_int16(value) : String serialize_u_int16, serialize_u_int32(value) : String serialize_u_int32, serialize_u_int64(value) : String serialize_u_int64, serialize_u_int8(value) : String serialize_u_int8

Class Method Detail

def self.config : Hash(String, String) #

[View source]
def self.job_type : String #

[View source]
def self.queue #

[View source]

Instance Method Detail

def executed : Bool #

[View source]
def executed? : Bool #

Did the job execute?


[View source]
def fail #

To be called from inside a #perform Marks this job as a failure. If the job is a candidate for re-scheduling, it will be run again at a later time.


[View source]
def failed? : Bool #

Did the job run and fail?


[View source]
def log(message) #

[View source]
def perform #

abstract, override in a Job descendant to do something productive


[View source]
def rescheduleable? : Bool #

abstract, override if desired.


[View source]
def run #

[View source]
def succeeded : Bool #

[View source]
def succeeded? : Bool #

Did the job run and succeed?


[View source]
def task_id : String | Nil #

[View source]
def task_id=(task_id : String | Nil) #

[View source]

Macro Detail

macro throttle(limit, period) #

[View source]