Files
externals/linux/doc/Onixs.CME.4.8.0/html/UnderstandingHandlerEvents_8md_source.html
T

82 lines
44 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/UnderstandingHandlerEvents.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/UnderstandingHandlerEvents.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="UnderstandingHandlerEvents_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 handler-events</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 Handler processing machinery regarding </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;events raised by the Handler while processing market data. </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;\details Market data processing assumes performance or different procedures </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;like a large-scale recovery to catch-up up-to-date market state on late join </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;or requesting lost incremental data. While developing a trading solution, it&#39;s</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;important to know in which state market data processing currently resides. </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;To meet needs, the SDK exposes the OnixS::CME::MDH::HandlerListener </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;listener. The Handler invokes members of the given listener once instances </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;are bound using the OnixS::CME::MDH::Handler::registerListener member.</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;The following table summaries the Handler events.</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;&lt;table&gt;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; &lt;th&gt;Event&lt;/th&gt;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; &lt;th&gt;Description&lt;/th&gt;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; OnixS::CME::MDH::HandlerListener::onStarted</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; Invoked by the Handler when it starts market data processing </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; due to calling the OnixS::CME::MDH::Handler::start member. </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; OnixS::CME::MDH::HandlerListener::onStopped</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; Invoked by the Handler when it ends market data processing </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; due to calling the OnixS::CME::MDH::Handler::start member. </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; OnixS::CME::MDH::HandlerListener::onInstrumentRecovery</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; Invoked when the Handler spawns an instrument recovery. </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; Invoked when the Handler accomplishes an instrument recovery. </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; The Handler supplies the status of recovery (successful, incomplete, </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; failed) as an additional parameter.</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; OnixS::CME::MDH::HandlerListener::onMarketRecovery</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; Invoked when the Handler spawns a market recovery.</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; OnixS::CME::MDH::HandlerListener::onEndOfMarketRecovery</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; Invoked when the Handler accomplishes a market recovery. </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; The Handler supplies the status of recovery (successful, </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; incomplete, failed) as an additional parameter.</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; OnixS::CME::MDH::HandlerListener::onTcpRecovery</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; Invoked when the Handler recovers lost data via a TCP recovery feed. </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; OnixS::CME::MDH::HandlerListener::onEndOfTcpRecovery</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; Invoked when the Handler accomplishes recovering lost data via a TCP feed. </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; The Handler supplies the status of recovery (successful, incomplete, failed) </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; as an additional parameter.</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; OnixS::CME::MDH::HandlerListener::onRealtimeProcessing</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; Invoked by the Handler when real-time processing of incremental </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; data is either started or resumed after recovery of any kind (TCP, </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; snapshots). After invocation of the given callback, it is guaranteed </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; that incremental data is processed as soon as it arrives and without </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; any delays in processing. </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; OnixS::CME::MDH::HandlerListener::onEndOfRealtimeProcessing</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; Invoked when the Handler suspends real-time processing of </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; incremental data due to a processing issue or data loss. </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;&lt;/table&gt;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;\section handler-event-invocation-seq Event Invocation Sequence </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;The configuration and settings for data processing session define </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;the behavior of the Handler. Therefore, each market data processing </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;pattern defines a primary sequence of events the Handler raises. </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;Also, a sequence of events depends on the conditions the Handler occurs. </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;For example, if data is lost, the Handler may perform recovery </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;procedures according to its configuration. An issue may take place during </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;recovery or data processing. Therefore, *a chain of events is not </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;strictly defined for live market data processing, although there&#39;s </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;explicit predictability in events for each case and conditions the </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;Handler occurs in*. </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;The following sections guide through the Handler behavior for major cases.</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;\note For each case which may take place while processing market data, </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;the Handler has an established procedure which defines exact behavior for </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;the case. Therefore, it&#39;s not necessary to perform any additional steps </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;to instruct the Handler what to do in the case. The Handler manages </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;itself and notifies the users on stages of its behavior.</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;\section instrument-recovery-events Instrument Definition Recovery and Events</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;When the Handler starts performing instrument definition recovery, </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;it invokes the OnixS::CME::MDH::HandlerListener::onInstrumentRecovery </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;callback. The event is raised before any instrument definition is </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;processed. Once instrument recovery is started, the Handler listens </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;to data on instrument feed and processes received packets. The end </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;of recovery is detected by the Handler based on data processed. The </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;Handler calls the OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;upon the end of successful processing of an instrument definition recovery loop.</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;The Handler may invoke the </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;OnixS::CME::MDH::HandlerListener::onInstrumentRecovery </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;and the OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;members multiple times before it switches performing other steps </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;like market recovery or resumes real-time processing. The given behavior </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;may happen due to issues experienced by the Handler while processing </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;data from an instrument feed. If error occurs, the Handler will </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;call the OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;with the OnixS::CME::MDH::RecoveryCompletionArgs::status equal to </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;OnixS::CME::MDH::RecoveryCompletionStatus::Failed. </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;The OnixS::CME::MDH::RecoveryCompletionArgs::details member includes </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;a detailed description of the issue caused recovery failure. </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;As noted in previous sections, users do not need to perform any additional</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;steps in such case. The Handler automatically restarts an instrument </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;recovery procedure. The instrument recovery is restarted as many times </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;as necessary to get successful processing of single recovery loop. </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;\subsection insrument-cache-events Recoverying Insrument Definition from Cache</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;The Handler may recover instrument definitions from a previously </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;saved cache. Using an instrument definition cache usually helps </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;to quickly pass an instrument definition recovery stage and move </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;to further processing. From events perspective, the Handler raises </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;the same pair of events identifying the beginning and the end of </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;the instrument definition recovery. </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;If an instrument definition cache is corrupted or can&#39;t be successfully </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;processed for any other reason, the Handler will end recovery from cache </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;by invoking the OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;with the OnixS::CME::MDH::RecoveryCompletionArgs::status equal to the </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;OnixS::CME::MDH::RecoveryCompletionStatus::Failed. </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;If cache is not yet available, the Handler will end recovery from the cache </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;by invoking the OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;with the OnixS::CME::MDH::RecoveryCompletionArgs::status equal to the </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;OnixS::CME::MDH::RecoveryCompletionStatus::Incomplete. </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;In both cases (if the cache is either corrupted or not yet available) the </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;Handler restarts an instrument definition recovery from the live network </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;feed.</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;The following diagram represents a visual </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;overview of the instrument definition recovery:</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;![Instrument Definition Recovery And Events](@ref InstrumentRecovery-Events.jpg)</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;\section market-recovery-events Market State Recovery and Events</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;Market recovery procedure may be spawned by the Handler to catch-up up-to-date</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;market state while joining market or due to other reasons like processing failure.</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;When the Handler starts performing market recovery, it invokes </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;the OnixS::CME::MDH::HandlerListener::onMarketRecovery callback. </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;The event is raised before any snapshot is processed. </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;Once a market state recovery is started, the Handler listens to </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;data on snapshot feeds and processes received data. The end of </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;recovery is detected by the Handler based on data processed. The </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;Handler calls the OnixS::CME::MDH::HandlerListener::onEndOfMarketRecovery </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;upon the end of successful processing of the snapshot recovery loop. </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;The Handler may invoke the OnixS::CME::MDH::HandlerListener::onMarketRecovery </div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;and the OnixS::CME::MDH::HandlerListener::onEndOfMarketRecovery multiple </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;times before it resumes real-time processing of incremental data. The given </div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;behavior may take place due to issues experienced by the Handler while processing </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;data like gaps in cached incremental data. If an error occurs, the Handler </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;calls the OnixS::CME::MDH::HandlerListener::onEndOfMarketRecovery with </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;the OnixS::CME::MDH::RecoveryCompletionArgs::status equal to </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;OnixS::CME::MDH::RecoveryCompletionStatus::Failed. The </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;OnixS::CME::MDH::RecoveryCompletionArgs::details member includes </div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;a detailed description of the issue caused recovery failure. </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;Similar to the instrument definition recovery, users do not need to </div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;perform any additional steps in such case. The Handler automatically </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;restarts a market recovery procedure. The market recovery is restarted </div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;as many times as necessary to get successful processing of snapshot </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;recovery loop. </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;The Handler may switch performing an instrument recovery before repeating </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;an attempt to recover a market state from snapshots in case of market recovery </div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;failure. The given behavior happens if a processing session is configured to </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;recover both instruments and the market state on data gap or processing failure </div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;(see the OnixS::CME::MDH::GapAndErrorHandlingOptions::RecoverInstrumentsAndMarketState</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;for more information).</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;A market recovery can accomplish with the </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;OnixS::CME::MDH::RecoveryCompletionStatus::Incomplete status. </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;When the Handler ends processing of recovery data from snapshots, </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;it applies incremental data queued during recovery. While processing </div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;queued incremental data, The Handler verifies market recovery integrity. </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;It may happen that MDP did not send snapshot for an instrument which </div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;incremental book updates were queued during the recovery. In such case, </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;the Handler restarts the market recovery to avoid book maintenance errors.</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;\note The described MDP behavior is not considered as an error. </div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;Therefore, if a processing session is configured to recover instruments </div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;in case of data loss and processing errors, the Handler does not </div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;recover instruments if the market recovery ends with </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;OnixS::CME::MDH::RecoveryCompletionStatus::Incomplete status.</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;\subsection market-recovery-parts Market By Order and Market By Price Recovery</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;A market recovery may assume processing of recovery data from multiple </div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;sources. With the invention of Market By Order functionality, CME MDP now </div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;offers two independent sources of recovery data for market by order and </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;market by price. The Handler processes recovery loops from either one or </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;all sources depending on the settings of a processing session (see the </div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;OnixS::CME::MDH::SesionSettings::marketRecovery parameter for more </div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;information). From the event perspective, there&#39;s no difference whether </div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;the Handler performs recovery of the market by order or price or both. *All </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;recovery-related steps, including processing of queued incremental data </div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;after processing snapshots, is done between invocations of the </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;OnixS::CME::MDH::HandlerListener::onMarketRecovery and the </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;OnixS::CME::MDH::HandlerListener::onEndOfMarketRecovery </div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;members*. </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;![Market Recovery And Events](@ref SessionSettings-MarketRecovery.jpg)</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;\section realtime-processing-events Real-time Processing of Incremental Data</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;When the Handler either starts or resumes processing of incremental </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;data after recovery, it notifies about the given event via the </div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;OnixS::CME::MDH::HandlerListener::onRealtimeProcessing callback. </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;Real-time processing of incremental data means that data is processed </div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;as soon as it is received without any delays (except the case when the </div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;Handler keeps out-of-order data waiting for a short period of time </div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;for missing data to arrive).</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;By invoking the OnixS::CME::MDH::HandlerListener::onRealtimeProcessing </div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;the Handler informs on the fact incremental data is not processed under </div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;other conditions like the market or TCP recovery. </div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160;</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;If the Handler faces an issue like a gap in incremental data </div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;or book maintenance error, it suspends real-time processing </div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;of the incremental data and signals about this via the </div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;OnixS::CME::MDH::HandlerListener::onEndOfRealtimeProcessing. </div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;Once the callback is invoked, the Handler performs an issue </div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;handling according to its settings. For example, if the Handler</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;detected a gap in incremental data and the TCP recovery service </div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;is bound to the Handler, it tries to recover missing packets using </div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;the TCP recovery facility. At the given stage the Handler raises </div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;events which are related to TCP recovery. Similar, if the Handler</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;spawns a large-scale market recovery, then the events related with </div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;the market and optionally instrument recovery are raised. When </div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;an issue handling is accomplished, the Handler resumes real-time </div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;processing of incremental data and notify a user code about this using </div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;the OnixS::CME::MDH::HandlerListener::onRealtimeProcessing member.</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;The diagram below visualizes aspects of the real-time processing of incremental data:</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;![Real-time Processing of Incremental Data](@ref IncrementalProcessing-Overview.jpg)</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;\section tcp-recovery-events Recovering Missing Data from TCP Recovery Feed</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;CME MDP offers the TCP Recovery Feed to let applications </div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;recover missing data without spawning a large-scale recovery </div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;from snapshots. The Handler supports given functionality by </div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;using a bound instance of the OnixS::CME::MDH::TcpRecoveryService </div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;class. When a gap in incremental data is detected, the Handler </div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;suspends real-time processing of incremental data and tries to </div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;recover missing packets via the TCP recovery service. At the </div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;beginning of each attempt the Handler invokes the </div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;OnixS::CME::MDH::HandlerListener::onTcpRecovery callback </div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;indicating begin of the TCP recovery procedure. Once all </div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;missing packets are received and processed successfully, the </div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;Handler ends the recovery procedure and notifies about that </div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;through the OnixS::CME::MDH::HandlerListener::onEndOfTcpRecovery </div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;callback. </div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160;The Handler may perform multiple attempts to recover missing </div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;data through the TCP Recovery. Each time an attempt is made, </div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;pair of the OnixS::CME::MDH::HandlerListener::onTcpRecovery and </div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;the OnixS::CME::MDH::HandlerListener::onTcpRecovery callbacks </div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;is invoked. If an attempt fails, the Handler uncovers a reason </div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160;of the failure as the OnixS::CME::MDH::RecoveryCompletionArgs::details </div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;member of the OnixS::CME::MDH::RecoveryCompletionArgs parameter. </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>