forked from erlware/erlcron
/
erlcron.erl
147 lines (128 loc) · 4.73 KB
/
erlcron.erl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
%%%----------------------------------------------------------------
%%% @author Eric Newhuis <enewhuis@ecdmarket.com>
%%% @copyright 2009-2010 eCD Market
%%%----------------------------------------------------------------,
-module(erlcron).
-export([validate/1,
cron/1,
at/2,
once/2,
cancel/1,
datetime/0,
set_datetime/1,
multi_set_datetime/1,
multi_set_datetime/2]).
-export_type([job/0,
job_ref/0,
run_when/0,
callable/0,
dow/0,
dom/0,
period/0,
duration/0,
constraint/0,
cron_time/0,
datetime/0,
time/0,
date/0,
seconds/0]).
-type seconds() :: integer().
-type date() :: {integer(), integer(), integer()}.
-type time() :: {integer(), integer(), integer()}.
-type datetime() :: {date(), time()}.
-type cron_time() :: {integer(), am | pm} | {integer(), integer(), am | pm}.
-type constraint() :: {between, cron_time(), cron_time()}.
-type duration() :: {integer(), hr | min | sec}.
-type period() :: cron_time() | [cron_time()] | {every, duration(), constraint()}.
-type dom() :: integer().
-type dow() :: mon | tue | wed | thu | fri | sat | sun.
-type callable() :: mfa() | function().
-type run_when() :: {once, seconds()}
| {daily, period()}
| {weekly, dow(), period()}
| {monthly, dom(), period()}.
-type job() :: {run_when(), callable()}.
-opaque job_ref() :: {integer(), reference()}.
%%%===================================================================
%%% API
%%%===================================================================
%%--------------------------------------------------------------------
%% @doc
%% Check that the spec specified is valid or invalid
%% @end
%%--------------------------------------------------------------------
-spec validate(run_when()) -> valid | invalid.
validate(Spec) ->
ecrn_agent:validate(Spec).
%%--------------------------------------------------------------------
%% @doc
%% 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.
%% @end
%%--------------------------------------------------------------------
-spec cron(job()) -> job_ref().
cron(Job) ->
JobRef = make_ref(),
ecrn_cron_sup:add_job(JobRef, Job),
JobRef.
%%--------------------------------------------------------------------
%% @doc
%% Convienience method to specify a job run to run on a daily basis
%% at a specific time.
%% @end
%%--------------------------------------------------------------------
-spec at(time() | seconds(), function()) -> job_ref().
at(When, Fun) ->
Job = {{daily, When}, Fun},
cron(Job).
%%--------------------------------------------------------------------
%% @doc
%% Run the specified job once after the amount of time specifed.
%% @end
%%--------------------------------------------------------------------
-spec once(time() | seconds(), function()) -> job_ref().
once(When, Fun) ->
Job = {{once, When}, Fun},
cron(Job).
%%--------------------------------------------------------------------
%% @doc
%% Cancel the job specified by the jobref.
%% @end
%%--------------------------------------------------------------------
-spec cancel(job_ref()) -> ok.
cancel(JobRef) ->
ecrn_control:cancel(JobRef).
%%--------------------------------------------------------------------
%% @doc
%% Get the current date time of the running erlcron system.
%% @end
%%--------------------------------------------------------------------
-spec datetime() -> datetime().
datetime() ->
ecrn_control:datetime().
%%--------------------------------------------------------------------
%% @doc
%% Set the current date time of the running erlcron system.
%% @end
%%--------------------------------------------------------------------
-spec set_datetime(datetime()) -> ok.
set_datetime(DateTime) ->
ecrn_control:set_datetime(DateTime).
%%--------------------------------------------------------------------
%% @doc
%% Set the current date time of the erlcron system running on different nodes.
%% @end
%%--------------------------------------------------------------------
-spec multi_set_datetime(datetime()) -> ok.
multi_set_datetime(DateTime) ->
ecrn_control:multi_set_datetime([node()|nodes()], DateTime).
%%--------------------------------------------------------------------
%% @doc
%% Set the current date time of the erlcron system running on the
%% specified nodes
%% @end
%%--------------------------------------------------------------------
-spec multi_set_datetime([node()], datetime()) -> ok.
multi_set_datetime(Nodes, DateTime) when is_list(Nodes) ->
ecrn_control:multi_set_datetime(Nodes, DateTime).