82 lines
8.8 KiB
HTML
82 lines
8.8 KiB
HTML
<!-- HTML header for doxygen 1.8.11-->
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>OnixS C++ CME Market Data Handler: Pages/UserDefinedWatchService.md Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="onixs-doxygen.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">
|
|
$(window).scroll(function() {
|
|
if ($(this).scrollTop() > 1)
|
|
{
|
|
$('header').addClass("sticky");
|
|
}
|
|
else
|
|
{
|
|
$('header').removeClass("sticky");
|
|
}
|
|
});
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><a href="http://www.onixs.biz"><img alt="Logo" src="onixs.svg"/></a></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">OnixS C++ CME Market Data Handler
|
|
 <span id="projectnumber">4.8.0.10</span>
|
|
</div>
|
|
<div id="projectbrief">API documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</header>
|
|
<div id="wrapper">
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Home</span></a></li>
|
|
<li><a href="modules.html"><span>Contents</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Pages/UserDefinedWatchService.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="UserDefinedWatchService_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> \addtogroup user-defined-watch-service </div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> \brief Explains Watch concept and its usage across different corners of SDK. </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> By default, the Handler uses a precise watch returning UTC time </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> (Universal Time Coordinated). The SDK exposes the given watch </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> service as the OnixS::CME::MDH::UtcWatch class. It's used by </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> the Feed Engine to assign the receive time for incoming data and </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> to determine timeouts. File-based implementation of the Logger </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> abstraction also uses the noted watch to label logged events.</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> However, the SDK allows switching using a different watch including </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> the custom implementation providing faster or more precise timing. </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> For this reason, the SDK exposes the OnixS::CME::MDH::WatchService </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> abstract class. Users may bind its instances to the other services </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> requiring a watch like the Feed Engine or the Logger.</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> A custom watch must be derived from the OnixS::CME::MDH::WatchService</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> class. Afterwards, an instance of a derived descendant must be associated </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> with a corresponding service. </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> The following code depicts how to make the Feed Engine to timestamp packets </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> with a local time. The SDK includes ready-to-use implementation of a watch </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> returning local time. Therefore, an instance of a local watch is always </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> available for the users.</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> ~~~{.cpp}</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> // Watch returning local time is always available.</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> WatchService& localWatch = LocalWatch::service();</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> FeedEngineSettings feSettings;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> feSettings.watch(localWatch);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> ~~~</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> \note Feed Engine uses multiple threads as well as Logger implementations </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> may be multi-threaded. Therefore, OnixS::CME::MDH::WatchService::now can be </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> called concurrently and thus it must be thread safe.</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> \section timestamp-impl-details Timestamp</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> OnixS::CME::MDH::WatchService::now returns time as instance of OnixS::CME::MDH::Timestamp </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> class. Internally OnixS::CME::MDH::Timestamp corresponds to CME MDH timestamp representation</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> using unsigned 64-bit integer storing a number of nanoseconds since Unix Epoch </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> (01-01-1970 00:00:00 UTC). So the most effective way to pass a number of nanoseconds since </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> Epoch while constructing an instance of the class.</div></div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.11-->
|
|
<!-- start footer part -->
|
|
<footer>
|
|
<hr class="footer"/>
|
|
<address class="footer">
|
|
<small>© <a href="http://www.onixs.biz">Onix Solutions [On<span class="corporate-orange">i</span>x<span class="corporate-orange">S</span>]</a>. All rights reserved.</small>
|
|
</address>
|
|
</footer>
|
|
</div> <!-- wrapper -->
|
|
</body>
|
|
</html>
|