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

82 lines
48 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/MigrationGuide.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/MigrationGuide.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="MigrationGuide_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 migration-guide</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 Covers aspects on migrating from previous releases.</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;Although given release is based on the same processing core as a previous major </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;version release, a lot of aspects have been principally redesigned and improved. </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;Given section covers major differences for painless migration from previous releases. </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;\section migrate-listener-consolidation Consolidated Listeners</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;In previous generations of SDK, listeners were designed to cover smallest </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;aspects of market data processingand thus API contained bunch of listeners </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;to be used to get market-related events handled in a regular application. </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;For example, there was a `OnixS::CME::MDP3::SecurityDefinitionListener` whose</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;members were involved once instrument definition was received and updated. </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;For each type of book there was corresponding listener exposing books after</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;updates. Atomic book changes could be accessed through another set of listeners. </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;To reduce overhead caused by necessity of using wide range of listeners and </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;to bring more clarity, most of listeners have been consolidated.</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;Primary principle was to consolidated Handler, Market Data (message) and Security</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;related events. Table below depicts basic correspondence between old and new listeners.</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;&lt;table&gt;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; &lt;th&gt;Old Listeners&lt;/th&gt;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; &lt;th&gt;New Listener&lt;/th&gt;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; &lt;th&gt;Notes&lt;/th&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::MDP3::HandlerStateChangeListener`</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; `OnixS::CME::MDP3::WarningListener`</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; `OnixS::CME::MDP3::ErrorListener`</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; `OnixS::CME::MDH::HandlerListener`</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; State change and issue (warning, error) events were merged into the new </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; listener containing callbacks which are invoked to notify users on various </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; aspects of market data processing by Handler. </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; &lt;/tr&gt;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; &lt;tr&gt;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; `OnixS::CME::MDP3::MessageProcessingListener`</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; `OnixS::CME::MDP3::EventMessageListener`</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; `OnixS::CME::MDP3::EventListener`</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; `OnixS::CME::MDH::MarketDataListener`</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; OnixS::CME::MDH::MarketDataListener represents adoptation of </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; `OnixS::CME::MDP3::MessageProcessingListener` to the new messaging </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; subsystem. Since unified FIX message container was substituted with</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; typified SBE messages as they are defined in CME specification, </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; listener was enhanced with overloads for each type of new message.</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; Also, new members defining bounds of packet processing have been </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; added. For this reason old `EventMessageListener` and `EventListener`</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; listeners were removed from API as the improved market data listener</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; allows to implement given event in easy way. </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; &lt;tr&gt;</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; `OnixS::CME::MDP3::SecurityDefinitionListener`</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; `OnixS::CME::MDP3::MboBookUpdateListener`</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; `OnixS::CME::MDP3::DirectBookUpdateListener`</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; `OnixS::CME::MDP3::ImpliedBookUpdateListener`</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; `OnixS::CME::MDP3::ConsolidatedBookUpdateListener`</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; `OnixS::CME::MDP3::MboBookChangeListener`</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; `OnixS::CME::MDP3::DirectBookChangeListener`</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; `OnixS::CME::MDP3::ImpliedBookChangeListener`</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; `OnixS::CME::MDP3::TradeListener`</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; `OnixS::CME::MDP3::OrderIdListener`</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; `OnixS::CME::MDP3::ElectronicVolumeListener`</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; `OnixS::CME::MDP3::StatisticsListener`</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; `OnixS::CME::MDP3::SecurityStatusListener`</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; `OnixS::CME::MDP3::RequestForQuoteListener`</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; &lt;td&gt;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; `OnixS::CME::MDH::SecurityListener`</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; &lt;td&gt;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; Security-related events are now consolidated into single listener.</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; Following important changes were done in the how particular cases</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; are handled:</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; - Unknown security definitions are now exposed through the </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; OnixS::CME::MDH::SecurityListener::onUndefined member which </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; also allows to update security attributes like security group, </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; asset, etc. Previously, unknown securities were not exposed </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; through security definition listeners. Instead, Handler raised</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; a warning on absence of definition. </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; - Trade summary processing has been reworked. Previously, SDK exposed </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; separate listeners for trades and order identifiers providing special </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; indexing for linking order ids with the trades. Now, trades are always </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; reported through the same OnixS::CME::MDH::SecurityListener::onTrade </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; callback. Order ids refering to a particular trade summary can be </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; gathered by the Handler and delivered together with a trade summary </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; instance depending on a trade summary handling strategy controlled by </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; OnixS::CME::MDH::HandlerSettings::tradeProcessing parameter value. </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; See \ref trade-order-details for more information. </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; - Previously, maintenance of books of a particular type was enabled by Handler</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; basing on registering instance of listener for that kind of books. Now, as Book</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; update callbacks consolidated into single listener together with the other events</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; maintenance is explicitly defined by corresponding parameters which define whether</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; particular overload of OnixS::CME::MDH::SecurityListener::onBookUpdate will be</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; invoked by the Handler or not. </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; &lt;/td&gt;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; &lt;/tr&gt;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;&lt;/table&gt;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;\section migrate-book-management Book Management</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;Previously, maitenance of books of particular type (MBO, direct, implied, </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;consolidated) was automatically enabled by Handler if either corresponding </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;listener was associated with an instance of OnixS::CME::MDH::Handler or</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;book maintenance was forcibly enabled through Handler&#39;s settings. </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;Also, depending on which listeners are registered (for example, listener for atomic </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;changes in direct order book), Handler selected appropriate source of recovery data </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;to catch-up up-to-date market state during late join or after detecting gap in incremental </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;data. For example, if user was interested in receiving MBO book updates without subscribing </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;to MBP book updates, Handler listened to recovery data on MBO snapshot feed only without </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;joining snapshot feed for MBP books. </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;In given release, Handler&#39;s behavior has been improved to be more clear for the users. </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;Book updates are now exposed through OnixS::CME::MDH::SecurityListener::onBookUpdate </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;members of consolidated listener for security-related data. However, overriding noted </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;virtual member doesn&#39;t mean subscribing to a book updates. Book maintenance is explicitly </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;defined by corresponding parameter from OnixS::CME::MDH::HandlerSettings::bookManagement() </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;section:</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;| Parameter Path | Description |</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;|------------------------------------------------------------------------------|----------------------------------------------------|</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;| `handlerSettings.bookManagement().mboBooks().maintain(bool status)` | Enables or disables MBO books maintenance |</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;| `handlerSettings.bookManagement().directBooks().maintain(bool status)` | Enables or disables direct books maintenance |</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;| `handlerSettings.bookManagement().impliedBooks().maintain(bool status)` | Enables or disables implied books maintenance |</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;| `handlerSettings.bookManagement().consolidatedBooks().maintain(bool status)` | Enables or disables consolidated books maintenance |</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;Once parameter is turned on, Handler invokes OnixS::CME::MDH::SecurityListener::onBookUpdate </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;overload corresponding to the type of book. </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;Also, behavior of the Handler in case of market recovery is now controlled by </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;OnixS::CME::MDH::SessionSettings::marketRecovery parameter. It allows to define </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;explicitly whether Handler must listen and process data from either MBO snapshot </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;feed or MBP snapshot feed or both feeds. </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;Given improvement in behavior of the Handler allows users to obtain desired </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;processing behavior without involving book maintenance. </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;\section migrate-books Book Classes</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;Book classes have been cleaned up. OnixS::CME::MDP3::BookBase::securityId and </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;OnixS::CME::MDP3::BookBase::lastAppliedSecurityLevelSeqNumber members have been </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;removed. </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;Data exposed by eliminated members is now consolidated into a new OnixS::CME::MDH::Security </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;class, containing all security-related attributes. Instances of given class are exposed in </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;all callbacks of OnixS::CME::MDH::SecurityListener listener. Therefore, security identifier</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;and instrument-level sequence number are now available for trade and statistics events. </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;| Old Member | New Member | Description |</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;|---|---|---|</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;| `OnixS::CME::MDP3::BookBase::securityId` | `OnixS::CME::MDH::Security::id` | Security id relocated from book to security instance |</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;| `OnixS::CME::MDP3::BookBase::lastAppliedSecurityLevelSeqNumber` | `OnixS::CME::MDH::Security::seqNumber` | Now available in other security-related callbacks |</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;\section migrate-feed-engine Feed Engine</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;Concept of \ref feed-engine was introduced in previous major release of the SDK</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;and given release inherits given concept. However, a few important changes have</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;been made. </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;Previosly, to provide backward compatibility with older minor releases, feed engine</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;could be constructed explicitly and bound with OnixS::CME::MDH::Handler instances.</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;If no instance of OnixS::CME::MDH::FeedEngine was associated with an instance of</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;OnixS::CME::MDH::Handler, then Handler constructed private instance of the feed engine. </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;In given release, implicit construction has been eliminated to provide better clarity</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;on Handler behavior and use of system resources. Therefore, to make live market data</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;processing happen, instance of OnixS::CME::MDH::FeedEngine must be constructed and </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;bound to the instance of OnixS::CME::MDH::Handler. </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;\note There&#39;s no limitation on number of feed engine instances constructed. </div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;Therefore, having single instance of OnixS::CME::MDH::FeedEngine for each </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;instance of OnixS::CME::MDH::Handler can be easy be achieved by constructing</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;and binding pair of instances. </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;\section migrate-feed-events Feed Events</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;Feed-related events have been redesigned. First of all, direct access to sockets </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;used to listen to multicast data has been eliminated. OnixS::CME::MDP3::FeedSocket </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;class is not available any more. Feed identification in events have been improved </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;and now feed is identified by OnixS::CME::MDH::NetFeed class containing primary </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;attributes of the feed which caused an event. </div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;Event listener was enhanced with a new member OnixS::CME::MDH::FeedListener::onFeedPacket</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;allowing to trace market data received by the Handler on a particular feed. An important</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;difference between this callback and the one in OnixS::CME::MDH::MarketDataListener is that </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;given callback is invoked by Handler every time data is received no matter whether this is </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;duplicated or out-of-order data. Given enhancement allows to implement various tracing </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;facilities to determine issues in data reception or its sequencing. </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;OnixS::CME::MDP3::FeedListener::onFeedSequenceIssues event and related with it functionality </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;was removed from the Handler. Instead, OnixS::CME::MDH::FeedListener::onFeedPacket can be used</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;to trace feeds for the issues.</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;\section migrate-instrument-cache Instrument Definition Cache</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;Handler exposes ability to cache instrument definitions received on live instrument </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;feed for further reuse at late join. Previously, Handler used predefined filename and</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;stored cache in a certain location. Therefore, settings exposed boolean parameter </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;OnixS::CME::MDP3::HandlerSettings::cacheSecurityDefinitions which allowed to either</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;enable or disable instrument definition caching. </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;In given release, behavior was been improved and now Handler allows to specify arbitrary </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;filename and location. Instrument definition caching is enabled while non-empty path to </div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;the cache is specified through OnixS::CME::MDH::HandlerSettings::instrumentCache parameter. </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;\section migrate-message-processing Message Processing</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;One of major improvements done in given release is redesigned message subsystem. </div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;In previous releases, market data was exposed through the OnixS::CME::MDP3::Message</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;class representing an unified container of FIX fields. In given release message</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;subsystem has been redesigned. Now market data messages are exposed to the users</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;as they are defined in XML-based specification published by CME. Given approach</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;gives more clarity on data structure and use and increases robustness.</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;| 3.X Release | 4.X Release |</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;|-------------|-------------|</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;| `OnixS::CME::MDP3::Message` | `OnixS::CME::MDH::ChannelReset` | </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;| | `OnixS::CME::MDH::AdminLogin` |</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;| | `OnixS::CME::MDH::AdminLogout` |</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;| | `OnixS::CME::MDH::InstrumentDefinitionFuture` |</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;| | `OnixS::CME::MDH::InstrumentDefinitionSpread` |</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;| | `OnixS::CME::MDH::InstrumentDefinitionOption` |</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;| | `OnixS::CME::MDH::SecurityStatus` |</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshBook` |</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshOrderBook` |</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshTrade` |</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshTradeSummary` |</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshVolume` |</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshSessionStatistics` |</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshDailyStatistics` |</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;| | `OnixS::CME::MDH::IncrementalRefreshLimitsBanding` |</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;| | `OnixS::CME::MDH::SnapshotFullRefresh` |</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;| | `OnixS::CME::MDH::SnapshotFullRefreshOrderBook` |</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;| | `OnixS::CME::MDH::QuoteRequest` |</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;OnixS::CME::MDH::MarketDataListener as the listener for the received </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;market data was enhanced with overloads for each type of SBE message. </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;Additionaly, since given release original network packets received on live feeds are exposed to the </div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;users through OnixS::CME::MDH::MarketDataListener interface as instances of OnixS::CME::MDH::Packet </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;class. Correspondently, listener was enhanced with OnixS::CME::MDH::MarketDataListener::onPacket and </div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;OnixS::CME::MDH::MarketDataListener::onEndOfPacket allowing to determine bounds of packet processing. </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;\section migrate-logger Event And Data Logging </div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;Logging layer was significantly reworked and abstraction of logging service was introduced. Now </div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;users can implement their logging service including memory-based ones. SDK offers ready-to-use </div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;implementation for logging events into a file. </div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;Following examples depict how to enable file-based logging for the Handler in previous and current releases:</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;\subsection migrate-logger-v3-sample Enabling logging in previous generations of SDK</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;~~~{.cpp}</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;HandlerSettings handlerSettings;</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;handlerSettings.logDirectory(&quot;logs&quot;);</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;handlerSettings.logMode(LogModes::Debug);</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;handlerSettings.advancedLogOptions(AdvancedLogOptions::LogEverything);</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;Handler handler(handlerSettings);</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;~~~</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;\subsection migrate-logger-v4-sample Enabling logging in latest generation of SDK</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;~~~{.cpp}</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;HandlerSettings handlerSettings;</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;Handler handler(handlerSettings);</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;//</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;FileLoggerSettings loggerSettings;</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;loggerSettings.filename(&quot;LogFile.txt&quot;);</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;loggerSettings.severityLevel(LogSeverity::Debug);</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;FileLogger logger(loggerSettings);</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;handler.bindLogger(logger);</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;~~~</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;For more information see \ref logging-options.</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;\section migrate-replay Log File Replay</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;The behavior of the Handler in case of replaying a log file has been changed. </div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;In previous releases, the replay was performed asynchronously. When a user invoked </div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;the OnixS::CME::MDH::Handler::start overload, the Handler spawned a new thread. </div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160;The actual log replay was done in the body of that thread. Therefore, the </div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;OnixS::CME::MDH::Handler::start overload returned control to its caller as </div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160;soon as a new thread was launched. Also, the end of replay could be detected </div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;only by using a special listener designed for that purpose. </div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160;</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;In the given major release, log file replay is a synchronous operation. </div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;Therefore, OnixS::CME::MDH::Handler::replay member does not return unless </div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;a log file is replayed. The new behavior simplifies user�s interaction with </div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;the replay and reduces the use of the system resources. </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160;However, the previous behavior of the replay functionality can be achieved. </div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;Users may launch additional threads and invoke the OnixS::CME::MDH::Handler::replay </div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;in the bodies of those threads. The previous behavior is achieved in such way. </div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;\section migrate-filtering Filtering</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160;Starting from given release, SDK exposes improved filtering to the users. Previously,</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;market data filtering was managed by set of routines exposed by the OnixS::CME::MDH::Handler</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;class like `OnixS::CME::MDP3::Handler::addSecurityIdFilter`. Also, there were inconsistency</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;related with filtering security definitions which consisted in the fact security definitions</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;were not filtered no matter users were interested in them or not. </div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160;In given release filtering was been redesigned and eliminates existent albiguities and inconsistencies </div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;available in previous releases. According to new concept, filtering is applied to security-related events </div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;consolidated into OnixS::CME::MDH::SecurityListener listener. Filtering is not used by the Handler on a </div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;market data level, therefore members of OnixS::CME::MDH::MarketDataListener are always invoked under </div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;same conditions and filtering has no influence on their invocation. </div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;For more information on how security-related events can be filtered, see \ref security-selection. </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>