|
| 1 | +<!-- HTML header for doxygen 1.11.0--> |
| 2 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 | +<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| 4 | +<head> |
| 5 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 6 | +<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 7 | +<meta name="generator" content="Doxygen 1.13.2"/> |
| 8 | +<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 9 | +<title>Time Shield Library: NTP Client</title> |
| 10 | +<link rel="icon" href="icon-64x64.png" type="image/x-icon" /> |
| 11 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 12 | +<script type="text/javascript" src="jquery.js"></script> |
| 13 | +<script type="text/javascript" src="dynsections.js"></script> |
| 14 | +<script type="text/javascript" src="clipboard.js"></script> |
| 15 | +<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script> |
| 16 | +<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script> |
| 17 | +<script type="text/javascript"> |
| 18 | + DoxygenAwesomeDarkModeToggle.init() |
| 19 | + DoxygenAwesomeParagraphLink.init() |
| 20 | +</script> |
| 21 | +<link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 22 | +<script type="text/javascript" src="navtreedata.js"></script> |
| 23 | +<script type="text/javascript" src="navtree.js"></script> |
| 24 | +<script type="text/javascript" src="resize.js"></script> |
| 25 | +<script type="text/javascript" src="cookie.js"></script> |
| 26 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 27 | +<script type="text/javascript" src="search/searchdata.js"></script> |
| 28 | +<script type="text/javascript" src="search/search.js"></script> |
| 29 | +<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 30 | +<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/> |
| 31 | +<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/> |
| 32 | +<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/> |
| 33 | +</head> |
| 34 | +<body> |
| 35 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 36 | +<div id="titlearea"> |
| 37 | +<table cellspacing="0" cellpadding="0"> |
| 38 | + <tbody> |
| 39 | + <tr id="projectrow"> |
| 40 | + <td id="projectalign"> |
| 41 | + <div id="projectname">Time Shield Library |
| 42 | + </div> |
| 43 | + <div id="projectbrief">C++ library for working with time</div> |
| 44 | + </td> |
| 45 | + </tr> |
| 46 | + </tbody> |
| 47 | +</table> |
| 48 | +</div> |
| 49 | +<!-- end header part --> |
| 50 | +<!-- Generated by Doxygen 1.13.2 --> |
| 51 | +<script type="text/javascript"> |
| 52 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 53 | +var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| 54 | +/* @license-end */ |
| 55 | +</script> |
| 56 | +<script type="text/javascript"> |
| 57 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 58 | +$(function() { codefold.init(0); }); |
| 59 | +/* @license-end */ |
| 60 | +</script> |
| 61 | +<script type="text/javascript" src="menudata.js"></script> |
| 62 | +<script type="text/javascript" src="menu.js"></script> |
| 63 | +<script type="text/javascript"> |
| 64 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 65 | +$(function() { |
| 66 | + initMenu('',true,false,'search.php','Search',true); |
| 67 | + $(function() { init_search(); }); |
| 68 | +}); |
| 69 | +/* @license-end */ |
| 70 | +</script> |
| 71 | +<div id="main-nav"></div> |
| 72 | +</div><!-- top --> |
| 73 | +<div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 74 | + <div id="nav-tree"> |
| 75 | + <div id="nav-tree-contents"> |
| 76 | + <div id="nav-sync" class="sync"></div> |
| 77 | + </div> |
| 78 | + </div> |
| 79 | + <div id="splitbar" style="-moz-user-select:none;" |
| 80 | + class="ui-resizable-handle"> |
| 81 | + </div> |
| 82 | +</div> |
| 83 | +<script type="text/javascript"> |
| 84 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 85 | +$(function(){initNavTree('group__ntp.html',''); initResizable(true); }); |
| 86 | +/* @license-end */ |
| 87 | +</script> |
| 88 | +<div id="doc-content"> |
| 89 | +<!-- window showing the filter options --> |
| 90 | +<div id="MSearchSelectWindow" |
| 91 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 92 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 93 | + onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 94 | +</div> |
| 95 | + |
| 96 | +<!-- iframe showing the search results (closed by default) --> |
| 97 | +<div id="MSearchResultsWindow"> |
| 98 | +<div id="MSearchResults"> |
| 99 | +<div class="SRPage"> |
| 100 | +<div id="SRIndex"> |
| 101 | +<div id="SRResults"></div> |
| 102 | +<div class="SRStatus" id="Loading">Loading...</div> |
| 103 | +<div class="SRStatus" id="Searching">Searching...</div> |
| 104 | +<div class="SRStatus" id="NoMatches">No Matches</div> |
| 105 | +</div> |
| 106 | +</div> |
| 107 | +</div> |
| 108 | +</div> |
| 109 | + |
| 110 | +<div class="header"> |
| 111 | + <div class="summary"> |
| 112 | +<a href="#files">Files</a> | |
| 113 | +<a href="#nested-classes">Classes</a> </div> |
| 114 | + <div class="headertitle"><div class="title">NTP Client</div></div> |
| 115 | +</div><!--header--> |
| 116 | +<div class="contents"> |
| 117 | + |
| 118 | +<p>Facilities for retrieving time using the Network Time Protocol. |
| 119 | +<a href="#details">More...</a></p> |
| 120 | +<table class="memberdecls"> |
| 121 | +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="files" name="files"></a> |
| 122 | +Files</h2></td></tr> |
| 123 | +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="ntp__client_8hpp.html">ntp_client.hpp</a></td></tr> |
| 124 | +<tr class="memdesc:ntp__client_8hpp"><td class="mdescLeft"> </td><td class="mdescRight">Simple NTP client for querying time offset from NTP servers. <br /></td></tr> |
| 125 | +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 126 | +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="wsa__guard_8hpp.html">wsa_guard.hpp</a></td></tr> |
| 127 | +<tr class="memdesc:wsa__guard_8hpp"><td class="mdescLeft"> </td><td class="mdescRight">Singleton guard for WinSock initialization. <br /></td></tr> |
| 128 | +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 129 | +</table><table class="memberdecls"> |
| 130 | +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
| 131 | +Classes</h2></td></tr> |
| 132 | +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtime__shield_1_1WsaGuard.html">time_shield::WsaGuard</a></td></tr> |
| 133 | +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Singleton guard for WinSock initialization. <a href="classtime__shield_1_1WsaGuard.html#details">More...</a><br /></td></tr> |
| 134 | +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 135 | +</table> |
| 136 | +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 137 | +<p>Facilities for retrieving time using the Network Time Protocol. </p> |
| 138 | +<p>This module contains a minimal client capable of querying remote NTP servers to measure the offset between local and network time. It uses WinSock via the <code>WsaGuard</code> helper and therefore works only on Windows.</p> |
| 139 | +<h3><a class="anchor" id="autotoc_md22"></a> |
| 140 | +Features:</h3> |
| 141 | +<ul> |
| 142 | +<li>Query NTP servers and obtain the time offset.</li> |
| 143 | +<li>Retrieve corrected UTC time in microseconds and milliseconds.</li> |
| 144 | +<li>Automatic WinSock initialization through <code>WsaGuard</code>.</li> |
| 145 | +<li>Requires network connectivity.</li> |
| 146 | +</ul> |
| 147 | +<h3><a class="anchor" id="autotoc_md23"></a> |
| 148 | +Example Usage:</h3> |
| 149 | +<div class="fragment"><div class="line"><a class="code hl_class" href="classtime__shield_1_1NtpClient.html">time_shield::NtpClient</a> client;</div> |
| 150 | +<div class="line"><span class="keywordflow">if</span> (client.query()) {</div> |
| 151 | +<div class="line"> int64_t offset = client.get_offset_us();</div> |
| 152 | +<div class="line"> int64_t utc_ms = client.get_utc_time_ms();</div> |
| 153 | +<div class="line">}</div> |
| 154 | +<div class="ttc" id="aclasstime__shield_1_1NtpClient_html"><div class="ttname"><a href="classtime__shield_1_1NtpClient.html">time_shield::NtpClient</a></div><div class="ttdef"><b>Definition</b> <a href="ntp__client_8hpp_source.html#l00222">ntp_client.hpp:222</a></div></div> |
| 155 | +</div><!-- fragment --> </div><!-- contents --> |
| 156 | +</div><!-- doc-content --> |
| 157 | +<!-- start footer part --> |
| 158 | +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 159 | + <ul> |
| 160 | + <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li> |
| 161 | + </ul> |
| 162 | +</div> |
| 163 | +</body> |
| 164 | +</html> |
0 commit comments