Overview

Module ecron

• Data Types
• Function Index
• Function Details

Data Types

crontab()

crontab() = #{second => '*' | [0..59 | {0..58, 1..59}, ...], minute => '*' | [0..59 | {0..58, 1..59}, ...], hour => '*' | [0..23, ...], month => '*' | [1..12 | {1..11, 2..12}, ...], day_of_month => '*' | [1..31 | {1..30, 2..31}, ...], day_of_week => '*' | [0..6 | {0..5, 1..6}, ...]}

crontab_spec()

crontab_spec() = crontab() | string() | binary() | 1..4294967

ecron()

ecron() = #{name => name(), crontab => crontab(), start_time => calendar:rfc3339_string() | unlimited, end_time => calendar:rfc3339_string() | unlimited, mfa => mfa(), type => cron | every}

end_datetime()

end_datetime() = unlimited | calendar:datetime()

name()

name() = term()

option()

option() = {singleton, boolean()} | {max_count, pos_integer() | unlimited}

options()

options() = [option()]

parse_error()

parse_error() = invalid_time | invalid_spec | month | day_of_month | day_of_week | hour | minute | second

start_datetime()

start_datetime() = unlimited | calendar:datetime()

statistic()

statistic() = #{ecron => ecron(), status => status(), failed => non_neg_integer(), ok => non_neg_integer(), results => [term()], run_microsecond => [pos_integer()], time_zone => local | utc, worker => pid(), next => [calendar:datetime()]}

status()

status() = waiting | running | deactivate | activate | already_ended

Function Index

Function Details

activate/1

activate an exist job, if the job is nonexistent, return {error, not_found}. if the job is already activate, nothing happened. the same effect as reinstall the job from now on.

add/3

Equivalent to add(JobName, Spec, MFA, unlimited, unlimited, []).

add/6

Add new crontab job. All jobs that exceed the limit will be automatically removed.

• JobName: The unique name of job, return {error, already_exist} if JobName is already exist.
• Spec: A cron expression represents a set of times.
• MFA: Spawn a process to run MFA when crontab is triggered.
• Start: The job's next trigger time is Calculated from StartDatetime. Keeping unlimited if start from now on.
• End: The job will be remove at end time. Keeping unlimited if never end.
• Opts: The optional list of options. {singleton, true}: Default job is singleton, Each task cannot be executed concurrently. {max_count, pos_integer()}: This task can be run up to MaxCount times, default is unlimited.

add_with_count/3

Equivalent to add_with_count(make_ref(), Spec, MFA, RunCount).

add_with_count/4

Equivalent to add(make_ref(), Spec, MFA, unlimited, unlimited, [{max_count, RunCount}]).

add_with_datetime/4

Equivalent to add(make_ref(), Spec, MFA, Start, End, []).

add_with_datetime/5

Equivalent to add(JobName, Spec, MFA, Start, End, []).

deactivate/1

deactivate an exist job, if the job is nonexistent, return {error, not_found}. just freeze the job, use @see activate/1 to unfreeze job.

delete/1

Delete an exist job, if the job is nonexistent, nothing happened.

parse_spec/2

parse a crontab spec with next trigger time. For debug.

send_after/3

Starts a timer which will send the message Msg to Dest when crontab is triggered.

• Equivalent to erlang:send_after/3 expect the Time format.
• If Dest is a pid() it has to be a pid() of a local process, dead or alive.
• The Time value can, in the current implementation, not be greater than 4294967295.
• If Dest is an atom(), it is supposed to be the name of a registered process. The process referred to by the name is looked up at the time of delivery. No error is given if the name does not refer to a process.
• If Dest is a pid(), the timer will be automatically canceled if the process referred to by the pid() is not alive, or when the process exits.
• Warning: Cancels a timer by erlang:cancel_timer(Ref) not ecron:delete/1.

send_interval/3

Equivalent to send_interval(make_ref(), Spec, Pid, Message, unlimited, unlimited, []).

send_interval/5

Equivalent to send_interval(make_ref(), Spec, self(), Message, Start, End, Option).

send_interval/7

Evaluates Pid ! Message repeatedly when crontab is triggered. (Pid can also be an atom of a registered name.)

• JobName: The unique name of job, return {error, already_exist} if the name is already exist.
• Spec: A cron expression represents a set of times.
• Pid: The target pid which receive message.
• Message: Any erlang term.
• Start: The job's next trigger time is Calculated from StartDatetime. Keeping unlimited if start from now on.
• End: The job will be remove at end time. Keeping unlimited if never end.
• Opts: The optional list of options. {singleton, true}: Default job is singleton, Each task cannot be executed concurrently. {max_count, pos_integer()}: This task can be run up to MaxCount times, default is unlimited.

statistic/0

Statistic for all jobs.

statistic/1

Statistic from an exist job. if the job is nonexistent, return {error, not_found}.

Overview

Generated by EDoc