Current section
Files
Jump to
Current section
Files
doc/ntpstat_monitor.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 ntpstat_monitor</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 ntpstat_monitor</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="NTP_client_ntpstat_monitor">NTP client ntpstat monitor</a></h3>.
<p>Copyright © 2025 Michael Truog</p>
<p><b>Version:</b> 2.0.8 May 15 2025 20:44:11
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="gen_server.html"><code>gen_server</code></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><code>mjtruog at protonmail dot com</code></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="NTP_client_ntpstat_monitor">NTP client ntpstat monitor</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-event">event()</a></h3>
<p><code>event() = {ntp, <a href="#type-status" docgen-rel="seetype" docgen-href="#status/0">status()</a>, <a href="#type-native_monotonic" docgen-rel="seetype" docgen-href="#native_monotonic/0">native_monotonic()</a>}</code></p>
<h3 class="typedecl"><a name="type-native_monotonic">native_monotonic()</a></h3>
<p><code>native_monotonic() = integer()</code></p>
<h3 class="typedecl"><a name="type-status">status()</a></h3>
<p><code>status() = ok | <a href="/home/george/organized/work/erlang/ntpstat/doc/ntpstat.html#type-status_error" docgen-rel="seetype" docgen-href="ntpstat:ntpstat#status_error/0">ntpstat:status_error()</a></code></p>
<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="#code_change-3">code_change/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#start_link-3">start_link/3</a></td><td>
<h4><a name="Start_a_process_to_monitor_ntpstat_values.">Start a process to monitor ntpstat values.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#stop_link-1">stop_link/1</a></td><td>
<h4><a name="Stop_a_ntpstat_monitor_process.">Stop a ntpstat monitor process.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="code_change-3">code_change/3</a></h3>
<div class="spec">
<p><code>code_change(X1, State, X3) -> any()</code></p>
<p> </p>
</div>
<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
<div class="spec">
<p><code>handle_call(Request, X2, State) -> any()</code></p>
<p> </p>
</div>
<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
<div class="spec">
<p><code>handle_cast(Request, State) -> any()</code></p>
<p> </p>
</div>
<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
<div class="spec">
<p><code>handle_info(Request, State) -> any()</code></p>
<p> </p>
</div>
<h3 class="function"><a name="init-1">init/1</a></h3>
<div class="spec">
<p><code>init(X1) -> any()</code></p>
<p> </p>
</div>
<h3 class="function"><a name="start_link-3">start_link/3</a></h3>
<div class="spec">
<p><code>start_link(ReceiverPid::pid(), IntervalSeconds::pos_integer(), Options::<a href="/home/george/organized/work/erlang/ntpstat/doc/ntpstat.html#type-options" docgen-rel="seetype" docgen-href="ntpstat:ntpstat#options/0">ntpstat:options()</a>) -> {ok, pid()} | {error, any()}</code><br></p>
<p> </p>
</div><p>
<h4><a name="Start_a_process_to_monitor_ntpstat_values.">Start a process to monitor ntpstat values.</a></h4>
</p>
<h3 class="function"><a name="stop_link-1">stop_link/1</a></h3>
<div class="spec">
<p><code>stop_link(Pid::pid()) -> ok</code><br></p>
<p> </p>
</div><p>
<h4><a name="Stop_a_ntpstat_monitor_process.">Stop a ntpstat monitor process.</a></h4>
</p>
<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
<div class="spec">
<p><code>terminate(X1, State) -> any()</code></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>