Current section

Files

Jump to
cloudi_service_cron doc cloudi_service_cron.html
Raw

doc/cloudi_service_cron.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_service_cron</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_service_cron</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_Cron_Service">CloudI Cron Service</a></h3><p>
Cron expression events are supported within the limitation defined by
erlang:system_info(end_time) (events during a 250 year period).
The cron expression string may use the 5 required fields
(minutes, hours, day_of_month, month, day_of_week),
6 fields with year as the last field,
7 fields with seconds as the first field or a supported macro
(@yearly, @annually, @monthly, @weekly, @daily, @midnight, @hourly).</p>.
<p>Copyright © 2019-2021 Michael Truog</p>
<p><b>Version:</b> 2.0.3 Dec 3 2021 19:11:42
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="deps/cloudi_core/doc/cloudi_service.html"><tt>cloudi_service</tt></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_Cron_Service">CloudI Cron Service</a></h3><p>
Cron expression events are supported within the limitation defined by
erlang:system_info(end_time) (events during a 250 year period).
The cron expression string may use the 5 required fields
(minutes, hours, day_of_month, month, day_of_week),
6 fields with year as the last field,
7 fields with seconds as the first field or a supported macro
(@yearly, @annually, @monthly, @weekly, @daily, @midnight, @hourly).</p>
<p>If the system clock is adjusted backwards, the same sequence of
events (described by the cron expression) occurs without redoing
events that have already occurred before the time change. That means
the adjustment backwards only delays the next event's occurrence
by the adjustment amount.</p>
If the system clock is adjusted forwards, an event may occur immediately
(when the system clock change is detected) due to the event time becoming
a time in the past. Each cron expression's next event will be a
a time in the future based on the updated current time
(events may have been skipped by adjusting the system clock forwards).
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_init-4">cloudi_service_init/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_terminate-3">cloudi_service_terminate/3</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_handle_info(Timeout_async_active, State, Dispatcher) -&gt; any()</tt></p>
<p> </p>
</div>
<h3 class="function"><a name="cloudi_service_init-4">cloudi_service_init/4</a></h3>
<div class="spec">
<p><tt>cloudi_service_init(Args, Prefix, Timeout, Dispatcher) -&gt; any()</tt></p>
<p> </p>
</div>
<h3 class="function"><a name="cloudi_service_terminate-3">cloudi_service_terminate/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_terminate(Reason, Timeout, State) -&gt; any()</tt></p>
<p> </p>
</div>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>