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

82 lines
20 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/FeedEngine.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/FeedEngine.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="FeedEngine_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 feed-engine </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 Feed Engine concept and its internals. </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;The Feed Engine concept encapsulates network-related aspects to let the </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;Handler focus on market data processing. It also provides advanced facilities </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;on utilizing system resources used by the Handler to achieve best performance </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;and latency characteristics.</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;Previously, there were no shared services between the Handler instances. </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;Thus, system resources were allocated exactly for and by a particular </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;instance. That caused certain inefficiency regarding resources utilization. </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;For example, each Handler instance used from one to two threads to manage </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;incoming market data processing. As a result, the number of threads used by </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;multiple Handler instances was multiplied by the number of those instances </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;and significantly exceeded the effective amount of resources required to </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;solve the market data processing task.</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;The concept of the Feed Engine was involved to make things more </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;efficient. The Feed Engine machinery is used by the Handler to </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;receive and process market data starting from the recent major </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;release. Multiple Handler instances can share a single instance </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;of the Feed Engine. </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;\section using-feed-engine Using Feed Engine</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;The OnixS::CME::MDH::FeedEngine class represents the Feed </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;Engine concept. Feed Engine events are reported through an </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;instance of the OnixS::CME::MDH::FeedEngineListener class, </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;associated with the Feed Engine instance at constructing </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;stage. </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;The following code sample depicts primary aspects of using </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;the Feed Engine with two Handler instances:</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;~~~{.cpp}</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;// STEP 1: is to set configuration parameters.</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;FeedEngineSettings feedEngineSettings;</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;feedEngineSettings.threadsCount(NUMBER_OF_WORKING_THREADS);</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;// STEP 2: is to construct shared feed engine.</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;FeedEngine feedEngine(feedEngineSettings);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;// STEP 3: is to bind feed engine to Handler instances.</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;handlerForChannel310.bindFeedEngine(feedEngine);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;handlerForChannel311.bindFeedEngine(feedEngine);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</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;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;\note Market data processing is done inside of working threads </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;managed by the Feed Engine. A size of the internal thread pool </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;is defined by the OnixS::CME::MDH::FeedEngineSettings::threadCount </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;parameter. </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;\section feed-engine-events Feed Engine Events</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;All Feed engine events are encapsulated into OnixS::CME::MDH::FeedEngineListener </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;class interface. OnixS::CME::MDH::FeedEngine class accepts an instance of listener </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;upon construction. </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;The following table uncovers Feed Engine events:</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;&lt;table&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;th&gt;Event&gt;&lt;/th&gt;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; &lt;th&gt;Description&lt;/th&gt;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; &lt;td&gt;OnixS::CME::MDH::FeedEngineListener::onFeedEngineThreadBegin&lt;/td&gt;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; Invoked by the Feed Engine working thread before entering a master </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; processing loop. </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; Event callback is invoked in the context of working thread allowing </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; the subscriber to perform thread-specific turning like setting affinity </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; or priority for the thread. </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;/tr&gt;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; &lt;td&gt;OnixS::CME::MDH::FeedEngineListener::onFeedEngineThreadEnd&lt;/td&gt;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; Invoked by Feed Engine when working thread is about to end. </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; The given event callback is invoked in the context of the working thread </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; allowing the subscriber to perform thread-specific cleanup like deleting </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; data stored in thread local storage.</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; &lt;td&gt;OnixS::CME::MDH::FeedEngineListener::onFeedEngineThreadIdle&lt;/td&gt;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; Invoked by the Feed Engine when the working thread is idle. </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; At an active phase, the Feed Engine working thread is running </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; a market data processing loop. The working thread may wait for </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; incoming market data using an appropriate I/O operation. </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; A working thread raises the given event if there was no </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; incoming data detected for a certain time interval (defined </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; by the OnixS::CME::MDH::FeedEngineSettings::dataWaitTime </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; parameter). The OnixS::CME::MDH::FeedEngineThreadIdleReasons::DataWaitTimeout</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; is passed as a reason of the idle state. </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; It may happen that a thread misses entering waiting for incoming data </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; because other threads have already been doing that for all active feeds, </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; and there are no other tasks like the processing already received market </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; data. In such case, the working threads spins for a certain time (defined </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; by the OnixS::CME::MDH::FeedEngineSettings::redundancySpinTime parameter </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; value) while waiting for any pending tasks to be executed. If no pending </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; tasks were found, the working thread enters an idle state with the </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; OnixS::CME::MDH::FeedEngineThreadIdleReasons::Redundant reason. </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; The given event callback also exposes a parameter-variable which value </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; represents the time interval the working thread is suggested to spend </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; sleeping to reduce races between working threads for executing pending </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; tasks (data reception, data processing, etc.) and thus to reduce a load </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; onto CPU. The parameter value can be modified inside the callback body. </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; \note It&#39;s not recommended to change the sleep time interval when </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; the working thread entered idle state after waiting for incoming data </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; to avoid overflow of a buffer used for incoming data.</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; \warning There&#39;s no predictability in firing the given event by the </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; Feed Engine. Each working thread may wait for incoming data or receive </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; incoming data or process data previously received by that or any other </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; threads. Availability of active tasks, which are executed by the working </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; threads, depends on many factors including some bound Handler instances, </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; system capacity, and a number of allocated working threads, </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; clock resolution and other factors. </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;&lt;/table&gt;</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>