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

82 lines
12 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/TcpRecovery.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/TcpRecovery.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="TcpRecovery_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 tcp-recovery-facility</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 Explains TCP Recovery facility.</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;\section tcp-recovery-concept Recovering from Data Loss</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;The Handler receives market data through the network multicast </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;feeds. Due to a multicast nature, data may come in the wrong order </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;or may be completely lost. The Handler does its best to fix all </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;the network-related issues. However, packet gaps may still happen</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;while processing market data.</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;The CME MDP provides its clients with an ability to request </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;and obtain lost data using a reliable TCP connection. This </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;facility is called a TCP Recovery. If the Handler is configured </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;to use a TCP Recovery facility, in case of data loss, it doesn&#39;t </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;report an error immediately and does not fall into a book recovery. </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;Instead, it suspends regular processing and requests a remote system </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;to resend missed data. The Handler resumes regular processing without </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;restarting its execution, once it successfully receives lost packets </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;from the service.</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</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;If a request to recover missed data through a TCP Recovery </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;feed fails, the Handler tries to recover lost packets for a</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;number of times defined by the </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;OnixS::CME::MDH::TcpRecoverySettings::reconnectAttempts </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;parameter. The Handler waits for </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;OnixS::CME::MDH::TcpRecoverySettings::reconnectInterval</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;milliseconds before a new attempt to recover lost data is </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;made. If the Handler was not able to recover lost packets for </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;a predefined number of attempts, it spawns a recovery from </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;snapshots or continues real-time processing as defined by </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;session settings.</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;\section enabling-tcp-recovery Enabling TCP Recovery</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;It is necessary to contact CME support for TCP Recovery </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;credentials to be able to use a TCP Recovery facility.</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;Also, the MDP does not allow multiple recovery requests served </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;simultaneously using the same credentials. Only one TCP recovery </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;session can be active at a time. For this reason, the SDK exposes </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;a TCP recovery feature as a shared service which can be bound to </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;multiple Handler instances. Implementation of this feature covers</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;all synchronization related aspects to avoid multiple requests at </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;the same time.</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;The following example demonstrates how to use TCP Recovery with the Handler:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;~~~{.cpp}</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;using namespace OnixS::CME::MDPH;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;// Configuring TCP Recovery.</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;TcpRecoverySetting tcpRecoverySettings;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;// Credentials are to be set as there&#39;s no defaults for</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;// these parameters. Other parameters have default values.</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;tcpRecoverySettings.username(&quot;CME&quot;);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;tcpRecoverySettings.password(&quot;CME&quot;);</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;// Constructing instance of TCP Recovery</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;// service and binding to the Handler.</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;TcpRecoveryService tcpRecovery(tcpRecoverySettings);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;// Configuring Handler.</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;HandlerSettings handlerSettings;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;handlerSettings.channel(310);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;handlerSettings.feeds().connectivityConfigurationFile(&quot;config.xml&quot;);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;Handler handler(handlerSettings);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;// Since this call, Handler will use</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;// TCP recovery in case of data loss.</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;handler.bindTcpRecovery(tcpRecovery);</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;~~~</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>