erlcron v1.2.1

View Source erlcron (erlcron v1.2.1)

Link to this section Summary

Types

callable/0
constraint/0
cron_opts/0
Cron default options applicable to all jobs. See job_opts().
cron_time/0
dom/0
dow/0
dow_day/0
duration/0
job/0
job_end/0
A function to be called after a job ended. The function is passed the job's result.
job_opts/0
Job options:
hostnames => [Hostname]
List of hostnames where the job is allowed to run
id => ID
An identifier of the job passed to on_job_start and on_job_end callbacks. It can be any term.
on_job_start => {Mod, Fun} | fun(JobRef, ID) -> any()
Mod:Fun(Ref::job_ref(), ID::any()) function to call on job start. The result is ignored.
{on_job_start, {Mod, Fun}} | fun(JobRef, ID, Result) -> term()
Mod:Fun(Ref::job_ref(), ID::any(), Result) function to call after a job has ended. Result is {ok, JobResult::term()} or {error, `{Reason, StackTrace}} if there is an exception.
job_ref/0
A job reference.
job_start/0
A function to be called before a job is started. If it returns the ignore atom, the job function will not be executed.
milliseconds/0
period/0
run_when/0
seconds/0

Functions

at(When, Fun)
Convenience method to specify a job to run once at the given time or after the amount of time specified.
at(JobRef, When, Fun)
at(JobRef, When, Fun, Opts)
cancel(JobRef)
Cancel the job specified by the jobref.
cron(Job)
Adds a new job to the cron system. Jobs are described in the job() spec. It returns the JobRef that can be used to manipulate the job after it is created.
cron(Job, DefOpts)
cron(JobRef, Job, Opts)
Schedule a job identified by a JobRef. A job reference can be a reference, atom, or binary. If it is an atom, a job will be locally registered by that name. Returns false if the job is not permitted to run on the current host
daily(When, Fun)
Convenience method to specify a job run to run on a daily basis at a specific time.
daily(JobRef, When, Fun)
daily(JobRef, When, Fun, Opts)
datetime()
Get the current date time of the erlcron system adjusted to reference.
epoch()
Get the current date time in seconds millisince epoch.
epoch_seconds()
Get the current date time in seconds since epoch.
get_all_jobs()
monthly(DOM, When, Fun)
Convenience method to specify a job run to run on a weekly basis at a specific time.
monthly(JobRef, DOM, When, Fun)
monthly(JobRef, DOM, When, Fun, Opts)
multi_set_datetime(DateTime)
Set the current date time of the erlcron system running on different nodes.
multi_set_datetime(Nodes, DateTime)
Set the current date time of the erlcron system running on the specified nodes
ref_datetime()
Get the reference date time of the erlcron system.
reset_datetime()
Reset the reference datetime of erlcron system to current epoch time.
set_datetime(DateTime)
Set the current date time of the running erlcron system using local time.
set_datetime(DateTime, TZ)
Set the current date time of the running erlcron system using either local or universal time. The TZ` parameter must contain an atom `local|universal.
validate(Spec)
Check that the spec specified is valid or invalid
weekly(DOW, When, Fun)
Convenience method to specify a job run to run on a weekly basis at a specific time.
weekly(JobRef, DOW, When, Fun)
weekly(JobRef, DOW, When, Fun, Opts)

Link to this section Types

Link to this type

callable/0

View Source 
-type callable() ::
    {M :: module(), F :: atom(), A :: [term()]} |
    fun(() -> term()) |
    fun((JobRef :: job_ref(), calendar:datetime()) -> term()).
Link to this type

constraint/0

View Source 
-type constraint() :: {between, cron_time(), cron_time()}.
Link to this type

cron_opts/0

View Source 
-type cron_opts() :: job_opts().
Cron default options applicable to all jobs. See job_opts().
Link to this type

cron_time/0

View Source 
-type cron_time() :: {integer(), am | pm} | {integer(), integer(), am | pm} | calendar:time().
Link to this type

dom/0

View Source 
-type dom() :: integer().
Link to this type

dow/0

View Source 
-type dow() :: dow_day() | [dow_day()].
Link to this type

dow_day/0

View Source 
-type dow_day() :: mon | tue | wed | thu | fri | sat | sun.
Link to this type

duration/0

View Source 
-type duration() :: {integer(), hr | h | min | m | sec | s}.
Link to this type

job/0

View Source 
-type job() ::
    {run_when(), callable()} |
    {run_when(), callable(), job_opts()} |
    #{id => job_ref(), interval => run_when(), execute => callable(), _ => any()}.
Link to this type

job_end/0

View Source 
-type job_end() ::
    fun((JobRef :: job_ref(), Res :: {ok, term()} | {error, {Reason :: term(), Stack :: list()}}) ->
            term()).
A function to be called after a job ended. The function is passed the job's result.
Link to this type

job_opts/0

View Source 
-type job_opts() ::
    #{hostnames => [binary() | string()],
      id => term(),
      on_job_start => {Mod :: atom(), Fun :: atom()} | job_start(),
      on_job_end => {Mod :: atom(), Fun :: atom()} | job_end()}.
Job options:
hostnames => [Hostname]
List of hostnames where the job is allowed to run
id => ID
An identifier of the job passed to on_job_start and on_job_end callbacks. It can be any term.
on_job_start => {Mod, Fun} | fun(JobRef, ID) -> any()
Mod:Fun(Ref::job_ref(), ID::any()) function to call on job start. The result is ignored.
{on_job_start, {Mod, Fun}} | fun(JobRef, ID, Result) -> term()
Mod:Fun(Ref::job_ref(), ID::any(), Result) function to call after a job has ended. Result is {ok, JobResult::term()} or {error, `{Reason, StackTrace}} if there is an exception.
Link to this type

job_ref/0

View Source 
-type job_ref() :: reference() | atom() | binary().
A job reference.
Link to this type

job_start/0

View Source 
-type job_start() :: fun((JobRef :: job_ref()) -> ignore | any()).
A function to be called before a job is started. If it returns the ignore atom, the job function will not be executed.
Link to this type

milliseconds/0

View Source 
-type milliseconds() :: integer().
Link to this type

period/0

View Source 
-type period() :: cron_time() | {every, duration()} | {every, duration(), constraint()}.
Link to this type

run_when/0

View Source 
-type run_when() ::
    {once, cron_time()} |
    {once, seconds()} |
    {daily, period()} |
    {weekly, dow(), period()} |
    {monthly, dom() | [dom()], period()}.
Link to this type

seconds/0

View Source 
-type seconds() :: integer().

Link to this section Functions

Link to this function

at(When, Fun)

View Source 
-spec at(cron_time() | seconds(), callable()) -> job_ref() | ignored | already_started | {error, term()}.
Convenience method to specify a job to run once at the given time or after the amount of time specified.
Link to this function

at(JobRef, When, Fun)

View Source 
-spec at(job_ref(), cron_time() | seconds(), function()) ->
      job_ref() | ignored | already_started | {error, term()}.
Link to this function

at(JobRef, When, Fun, Opts)

View Source 
-spec at(job_ref(), cron_time() | seconds(), function(), job_opts()) ->
      job_ref() | ignored | already_started | {error, term()}.
Link to this function

cancel(JobRef)

View Source 
-spec cancel(job_ref()) -> boolean().
Cancel the job specified by the jobref.
Link to this function

cron(Job)

View Source 
-spec cron(job()) -> job_ref() | ignored | already_started | {error, term()}.
Adds a new job to the cron system. Jobs are described in the job() spec. It returns the JobRef that can be used to manipulate the job after it is created.
Link to this function

cron(Job, DefOpts)

View Source 
-spec cron(job() | job_ref(), job() | cron_opts()) ->
        job_ref() | ignored | already_started | {error, term()}.
Link to this function

cron(JobRef, Job, Opts)

View Source 
-spec cron(job_ref(), job(), job_opts()) -> job_ref() | ignored | already_started | {error, term()}.
Schedule a job identified by a JobRef. A job reference can be a reference, atom, or binary. If it is an atom, a job will be locally registered by that name. Returns false if the job is not permitted to run on the current host
Link to this function

daily(When, Fun)

View Source 
-spec daily(cron_time() | seconds(), function()) ->
         job_ref() | ignored | already_started | {error, term()}.
Convenience method to specify a job run to run on a daily basis at a specific time.
Link to this function

daily(JobRef, When, Fun)

View Source 
-spec daily(job_ref(), cron_time() | seconds(), function()) ->
         job_ref() | ignored | already_started | {error, term()}.
Link to this function

daily(JobRef, When, Fun, Opts)

View Source 
-spec daily(job_ref(), cron_time() | seconds(), function(), job_opts()) ->
         job_ref() | ignored | already_started | {error, term()}.
Link to this function

datetime()

View Source 
-spec datetime() -> {calendar:datetime(), milliseconds()}.
Get the current date time of the erlcron system adjusted to reference.
Link to this function

epoch()

View Source 
-spec epoch() -> milliseconds().
Get the current date time in seconds millisince epoch.
Link to this function

epoch_seconds()

View Source 
-spec epoch_seconds() -> seconds().
Get the current date time in seconds since epoch.
Link to this function

get_all_jobs()

View Source 
-spec get_all_jobs() -> [job_ref()].
Link to this function

monthly(DOM, When, Fun)

View Source 
-spec monthly(dom(), cron_time() | seconds(), function()) ->
           job_ref() | ignored | already_started | {error, term()}.
Convenience method to specify a job run to run on a weekly basis at a specific time.
Link to this function

monthly(JobRef, DOM, When, Fun)

View Source 
-spec monthly(job_ref(), dom(), cron_time() | seconds(), function()) ->
           job_ref() | ignored | already_started | {error, term()}.
Link to this function

monthly(JobRef, DOM, When, Fun, Opts)

View Source 
-spec monthly(job_ref(), dom(), cron_time() | seconds(), function(), job_opts()) ->
           job_ref() | ignored | already_started | {error, term()}.
Link to this function

multi_set_datetime(DateTime)

View Source 
-spec multi_set_datetime(calendar:datetime()) -> {Replies, BadNodes}
                      when Replies :: [{node(), ok | {error, term()}}], BadNodes :: [node()].
Set the current date time of the erlcron system running on different nodes.
Link to this function

multi_set_datetime(Nodes, DateTime)

View Source 
-spec multi_set_datetime([node()], calendar:datetime()) -> {Replies, BadNodes}
                      when Replies :: [{node(), ok | {error, term()}}], BadNodes :: [node()].
Set the current date time of the erlcron system running on the specified nodes
Link to this function

ref_datetime()

View Source 
-spec ref_datetime() -> {calendar:datetime(), milliseconds()}.
Get the reference date time of the erlcron system.
Link to this function

reset_datetime()

View Source 
-spec reset_datetime() -> ok.
Reset the reference datetime of erlcron system to current epoch time.
Link to this function

set_datetime(DateTime)

View Source 
-spec set_datetime(calendar:datetime()) -> ok.
Set the current date time of the running erlcron system using local time.
Link to this function

set_datetime(DateTime, TZ)

View Source 
-spec set_datetime(calendar:datetime(), local | universal) -> ok.
Set the current date time of the running erlcron system using either local or universal time. The TZ` parameter must contain an atom `local|universal.
Link to this function

validate(Spec)

View Source 
-spec validate(run_when()) -> ok | {error, term()}.
Check that the spec specified is valid or invalid
Link to this function

weekly(DOW, When, Fun)

View Source 
-spec weekly(dow(), cron_time() | seconds(), function()) ->
          job_ref() | ignored | already_started | {error, term()}.
Convenience method to specify a job run to run on a weekly basis at a specific time.
Link to this function

weekly(JobRef, DOW, When, Fun)

View Source 
-spec weekly(job_ref(), dow(), cron_time() | seconds(), function()) ->
          job_ref() | ignored | already_started | {error, term()}.
Link to this function

weekly(JobRef, DOW, When, Fun, Opts)

View Source 
-spec weekly(job_ref(), dow(), cron_time() | seconds(), function(), job_opts()) ->
          job_ref() | ignored | already_started | {error, term()}.