Files
externals/linux/doc/Onixs.CME.4.8.0/html/BookNaturalRefresh_8md_source.html

82 lines
16 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/BookNaturalRefresh.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
&#160;<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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Pages/BookNaturalRefresh.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="BookNaturalRefresh_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>&#160;\addtogroup book-natural-refresh</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;\brief Uncovers the way the SDK implements the book natural refresh.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;In the regular case, the Handler keeps checking incoming packets transmitted </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;by MDP for gaps and uses recovery facilities like TCP Recovery and snapshot </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;feeds to keep order books in the up-to-date state. When market data loss occurs, </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;the Handler spawns market recovery using the market recovery feed. While </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;recovering market, the real-time market data is cached, and thus, </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;market data processing looks like suspended. </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;Natural refresh of order books supposes processing of real-time </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;(incremental) market data without involving market recovery. As </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;a result, the Handler processes the real-time market data as soon </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;as it is received from the feeds. As a drawback, order books may </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;not be fully recovered, and thus, some price levels may be absent. </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;\section detecting-book-and-price-levels-state Identifying Book State and Missed Price Levels</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;When recovery facilities are used, order books exposed by the Handler </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;are always fully reconstructed and in ôò up-to-date state. When books </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;are naturally refreshed, a part of price level information may be absent. </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;To differ whether order book is fully recovered or just partly </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;reconstructed, OnixS::CME::MDH::MboBook and OnixS::CME::MDH::MbpBook </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;classes expose OnixS::CME::MDH::MboBook::state and OnixS::CME::MDH::MbpBook::state </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;members correspondently. Returned value identifies whether book is fully reconstructed </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;(OnixS::CME::MDH::BookStates::Latest) or naturally refreshed </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;(OnixS::CME::MDH::BookStates::NaturallyRefreshed).</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;When an order book is naturally refreshed, some price levels may </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;be absent. Price level data types (OnixS::CME::MDH::DirectPriceLevel, </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;OnixS::CME::MDH::ImpliedPriceLevel) expose members </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;(OnixS::CME::MDH::DirectPriceLevel::exist(), </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;OnixS::CME::MDH::ImpliedPriceLevel::exist()) to check </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;whether actual data is available for particular bid or ask.</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;\note Data availability for particular bid or ask is not applicable for </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;MBO book. OnixS::CME::MDH::Order as the entry of MBO book does not provide </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;any member similar to OnixS::CME::MDH::DirectPriceLevel::exist(). Missing </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;orders just aren&#39;t available in a book without any space reservation.</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;\section book-natural-refresh-example Example</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;The following code depicts how to run the Handler in natural refresh mode:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;~~~{.cpp}</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;// 1. Establishing primary settings.</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;HandlerSettings settings;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;settings.channel(310);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;settings.</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; feeds().</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; connectivityConfigurationFile(&quot;config.xml&quot;);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;// 2. Constructing handler instance.</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;Handler handler(settings);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;// 3. Spawning natural refresh session.</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;handler.start(NaturalRefreshSession());</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;~~~</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;In other words, natural refresh defines the behavior of the Handler </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;in case of data loss and other issues while processing real-time data. </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;Since this major release, the Handler provides the ability to combine </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;natural refresh with other facilities like performing initial instrument </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;and market recovery as well as TCP recovery to request lost data.</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;The following example depicts how the Handler and its processing </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;session can be configured to combine natural refresh with an </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;initial late join recovery. </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;~~~{.cpp}</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;// Establishing primary settings.</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;HandlerSettings settings;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;settings.channel(310);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;settings.</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; feeds().</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; connectivityConfigurationFile(&quot;config.xml&quot;);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;// Constructing handler instance.</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;Handler handler(settings);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;// Configuring session. </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;SessionSettings sessionSettings;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;// This will force Handler to perform initial recovery </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;// as it&#39;s done during late join - instruments will be </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;// recovered and market state afterwards.</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;sessionSettings.</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; joinRecovery(</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; JoinRecovery::</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; InstrumentsAndMarketState);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;// Forbids market state recovery in case of data </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;// loss or processing error. Books will be naturally </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;// refreshed in case of issue.</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;sessionSettings.</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; gapAndErrorHandling(</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; GapAndErrorHandling::ContinueProcessing);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;// Spawns market data processing </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;// according to chosen session settings. </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;handler.start(sessionSettings);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;~~~</div></div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.11-->
<!-- start footer part -->
<footer>
<hr class="footer"/>
<address class="footer">
<small>&copy; <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>