82 lines
16 KiB
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
|
|
 <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/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> \addtogroup book-natural-refresh</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 Uncovers the way the SDK implements the book natural refresh.</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> In the regular case, the Handler keeps checking incoming packets transmitted </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> 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> 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> the Handler spawns market recovery using the market recovery feed. While </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> recovering market, the real-time market data is cached, and thus, </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> market data processing looks like suspended. </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> Natural refresh of order books supposes processing of real-time </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> (incremental) market data without involving market recovery. As </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> 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> 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> 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> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> \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> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> When recovery facilities are used, order books exposed by the Handler </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> 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> 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> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> To differ whether order book is fully recovered or just partly </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> reconstructed, OnixS::CME::MDH::MboBook and OnixS::CME::MDH::MbpBook </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> 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> members correspondently. Returned value identifies whether book is fully reconstructed </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> (OnixS::CME::MDH::BookStates::Latest) or naturally refreshed </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> (OnixS::CME::MDH::BookStates::NaturallyRefreshed).</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> When an order book is naturally refreshed, some price levels may </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> be absent. Price level data types (OnixS::CME::MDH::DirectPriceLevel, </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> OnixS::CME::MDH::ImpliedPriceLevel) expose members </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> (OnixS::CME::MDH::DirectPriceLevel::exist(), </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> OnixS::CME::MDH::ImpliedPriceLevel::exist()) to check </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> whether actual data is available for particular bid or ask.</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 Data availability for particular bid or ask is not applicable for </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> 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> any member similar to OnixS::CME::MDH::DirectPriceLevel::exist(). Missing </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> orders just aren't available in a book without any space reservation.</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> \section book-natural-refresh-example Example</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> 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> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> ~~~{.cpp}</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> // 1. Establishing primary settings.</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> HandlerSettings settings;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> settings.channel(310);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> settings.</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  feeds().</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  connectivityConfigurationFile("config.xml");</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> // 2. Constructing handler instance.</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> Handler handler(settings);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> // 3. Spawning natural refresh session.</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> handler.start(NaturalRefreshSession());</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> ~~~</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> In other words, natural refresh defines the behavior of the Handler </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> 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> Since this major release, the Handler provides the ability to combine </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> natural refresh with other facilities like performing initial instrument </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> 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> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> The following example depicts how the Handler and its processing </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> session can be configured to combine natural refresh with an </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> initial late join recovery. </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> ~~~{.cpp}</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> // Establishing primary settings.</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> HandlerSettings settings;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> settings.channel(310);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> settings.</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  feeds().</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  connectivityConfigurationFile("config.xml");</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> // Constructing handler instance.</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> Handler handler(settings);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> // Configuring session. </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> SessionSettings sessionSettings;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> // This will force Handler to perform initial recovery </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> // as it's done during late join - instruments will be </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> // recovered and market state afterwards.</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> sessionSettings.</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  joinRecovery(</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  JoinRecovery::</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  InstrumentsAndMarketState);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> // Forbids market state recovery in case of data </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> // loss or processing error. Books will be naturally </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> // refreshed in case of issue.</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> sessionSettings.</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  gapAndErrorHandling(</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  GapAndErrorHandling::ContinueProcessing);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> // Spawns market data processing </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> // according to chosen session settings. </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> handler.start(sessionSettings);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> ~~~</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>
|