82 lines
20 KiB
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
|
|
 <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/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> \addtogroup feed-engine </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 Feed Engine concept and its internals. </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> The Feed Engine concept encapsulates network-related aspects to let the </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> Handler focus on market data processing. It also provides advanced facilities </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> 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> and latency characteristics.</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> Previously, there were no shared services between the Handler instances. </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> Thus, system resources were allocated exactly for and by a particular </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> instance. That caused certain inefficiency regarding resources utilization. </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> 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> 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> multiple Handler instances was multiplied by the number of those instances </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> and significantly exceeded the effective amount of resources required to </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> solve the market data processing task.</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> 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> efficient. The Feed Engine machinery is used by the Handler to </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> receive and process market data starting from the recent major </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> release. Multiple Handler instances can share a single instance </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> of the Feed Engine. </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> \section using-feed-engine Using Feed Engine</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> The OnixS::CME::MDH::FeedEngine class represents the Feed </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> Engine concept. Feed Engine events are reported through an </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> instance of the OnixS::CME::MDH::FeedEngineListener class, </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> associated with the Feed Engine instance at constructing </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> stage. </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> The following code sample depicts primary aspects of using </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> the Feed Engine with two Handler instances:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> ~~~{.cpp}</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> // STEP 1: is to set configuration parameters.</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> FeedEngineSettings feedEngineSettings;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> feedEngineSettings.threadsCount(NUMBER_OF_WORKING_THREADS);</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> // STEP 2: is to construct shared feed engine.</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> FeedEngine feedEngine(feedEngineSettings);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> // STEP 3: is to bind feed engine to Handler instances.</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> handlerForChannel310.bindFeedEngine(feedEngine);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> handlerForChannel311.bindFeedEngine(feedEngine);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> ~~~</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> \note Market data processing is done inside of working threads </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> 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> is defined by the OnixS::CME::MDH::FeedEngineSettings::threadCount </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> parameter. </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> \section feed-engine-events Feed Engine Events</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> All Feed engine events are encapsulated into OnixS::CME::MDH::FeedEngineListener </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> 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> upon construction. </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> The following table uncovers Feed Engine events:</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> <table></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <tr></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <th>Event></th></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <th>Description</th></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </tr></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <tr></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <td>OnixS::CME::MDH::FeedEngineListener::onFeedEngineThreadBegin</td></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <td></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  Invoked by the Feed Engine working thread before entering a master </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  processing loop. </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>  Event callback is invoked in the context of working thread allowing </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  the subscriber to perform thread-specific turning like setting affinity </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  or priority for the thread. </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </td></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </tr></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <tr></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <td>OnixS::CME::MDH::FeedEngineListener::onFeedEngineThreadEnd</td></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <td></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  Invoked by Feed Engine when working thread is about to end. </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  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>  allowing the subscriber to perform thread-specific cleanup like deleting </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  data stored in thread local storage.</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </td></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </tr></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <tr></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <td>OnixS::CME::MDH::FeedEngineListener::onFeedEngineThreadIdle</td></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <td></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  Invoked by the Feed Engine when the working thread is idle. </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  At an active phase, the Feed Engine working thread is running </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  a market data processing loop. The working thread may wait for </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  incoming market data using an appropriate I/O operation. </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  A working thread raises the given event if there was no </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  incoming data detected for a certain time interval (defined </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  by the OnixS::CME::MDH::FeedEngineSettings::dataWaitTime </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  parameter). The OnixS::CME::MDH::FeedEngineThreadIdleReasons::DataWaitTimeout</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  is passed as a reason of the idle state. </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  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>  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>  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>  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>  by the OnixS::CME::MDH::FeedEngineSettings::redundancySpinTime parameter </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  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>  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>  OnixS::CME::MDH::FeedEngineThreadIdleReasons::Redundant reason. </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  The given event callback also exposes a parameter-variable which value </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  represents the time interval the working thread is suggested to spend </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  sleeping to reduce races between working threads for executing pending </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  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>  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>  </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  \note It's not recommended to change the sleep time interval when </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  the working thread entered idle state after waiting for incoming data </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  to avoid overflow of a buffer used for incoming data.</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  \warning There's no predictability in firing the given event by the </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  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>  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>  threads. Availability of active tasks, which are executed by the working </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  threads, depends on many factors including some bound Handler instances, </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  system capacity, and a number of allocated working threads, </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  clock resolution and other factors. </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </td></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </tr></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </table></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>
|