ecrn_cron_sup (erlcron v1.3.8)

Simple-one-for-one supervisor that owns all running cron job processes.

Each call to add_job/3 starts one ecrn_agent child under this supervisor. Jobs are transient: a job that finishes normally (e.g. a once job after it has run) is not restarted. A job that crashes unexpectedly is restarted up to the intensity limit configured by the sup_job_intensity and sup_job_period application environment variables (defaults: 3 restarts in 10 seconds).

Summary

Functions

add_job/1

Add a cron job under supervision (using default cron options).

add_job(JobRef, Job)

Add a cron job under supervision (using default cron options).

add_job/3

Add a cron job under supervision with the given options.

all_jobs()

Return PIDs of all currently supervised job processes.

check_task/2
init/1
start_link()
terminate(Pid)

Terminate the job process identified by Pid.

Functions

add_job/1

-spec add_job(map()) -> erlcron:job_ref().

Add a cron job under supervision (using default cron options).

add_job(JobRef, Job)

-spec add_job(erlcron:job_ref(), erlcron:job()) -> erlcron:job_ref().

Add a cron job under supervision (using default cron options).

add_job/3

-spec add_job(erlcron:job_ref(), erlcron:job(), erlcron:cron_opts()) ->
                 erlcron:job_ref() | ignored | already_started | {error, term()}.

Add a cron job under supervision with the given options.

Job-level options in Job (when it is a map or tuple-with-opts) are merged with CronOpts, with job-level options taking precedence. Returns ignored when the job is excluded by hostname restrictions.

all_jobs()

-spec all_jobs() -> [pid()].

Return PIDs of all currently supervised job processes.

check_task/2

init/1

start_link()

-spec start_link() -> {ok, pid()} | ignore | {error, Error :: term()}.

terminate(Pid)

Terminate the job process identified by Pid.