class Mosquito::PeriodicJobRun

Defined in:

mosquito/periodic_job_run.cr

Constant Summary

Log = ::Log.for(self)

Constructors

Instance Method Summary

Constructor Detail

def self.new(class __arg0 : ::Mosquito::PeriodicJob.class, interval : Time::MonthSpan | Time::Span) #

Instance Method Detail

def class : Mosquito::PeriodicJob.class #
Description copied from class Object

Returns the runtime Class of an object.

1.class       # => Int32
"hello".class # => String

Compare it with typeof, which returns the compile-time type of an object:

random_value = rand # => 0.627423
value = random_value < 0.5 ? 1 : "hello"
value         # => "hello"
value.class   # => String
typeof(value) # => Int32 | String

def class=(class __arg0 : Mosquito::PeriodicJob.class) #

def execute #

Enqueues the job for execution and records the job run id so that subsequent intervals can detect that a run is already pending.


def interval : Time::Span | Time::MonthSpan #

def interval=(interval : Time::Span | Time::MonthSpan) #

def last_executed_at #

The last executed timestamp, or "never" if it doesn't exist.


def last_executed_at=(time : Time) #

Updates the last executed timestamp in the backend, and schedules the metadata for deletion after 3*interval seconds.

For Time::Span intervals, the TTL is set to 3 * interval. For Time::MonthSpan intervals, the TTL is set to approximately 3 * interval.

A month is approximated to 2635200 seconds, or 30.5 days.


def last_executed_at? #

The last executed timestamp for this periodicjob tracked by the backend.


def metadata : Metadata #

def observer : Observability::PeriodicJob #

def pending_job_run? : Bool #

Returns true if a previously enqueued job run has not yet finished. This prevents duplicate enqueues when executors are busy and the periodic interval elapses multiple times before the job is run.


def try_to_execute : Bool #

Check the last executed timestamp against the current time, and enqueue the job if it's time to execute.