82 lines
25 KiB
HTML
82 lines
25 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/GettingStarted.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/GettingStarted.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="GettingStarted_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 getting-started</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 Guides through the most significant </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> parts of the Handler's architecture.</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> \details The OnixS::CME::MDH namespace encapsulates the SDK API.</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> The master `OnixS/CME/MDH.h` header file collects all header files </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> for more convenience.</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> Following sections guide through the major steps to be done </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> to succeed with market data processing.</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> \section specifying-license Initializing and Licensing SDK</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> The SDK needs a valid license for successful execution. If </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> the licensing subsystem is not able to find a valid license, </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> it throws an exception at the initialization stage when the </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> OnixS::CME::MDH::initialize is called. Also, a license is </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> verified each time an attempt to start market data processing </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> is done using the OnixS::CME::MDH::Handler::start member.</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> The OnixS::CME::MDH::InitializationSettings class exposes the </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> OnixS::CME::MDH::InitializationSettings::licenseStore member which </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> must be used to instruct the SDK where to look for a valid license. </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> By default, the licensing services look for a license in the current </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> directory of the application. However, by using noted parameter, it </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> is possible to specify another folder anywhere on file system. </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> \note The licensing subsystem looks for a valid license in the </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> specified folder and selects the best one. If multiple licenses </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> are available, it selects the most significant one (for example, </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> a production license is selected instead of a trial one if both </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> are available).</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> The following example demonstrates how to perform one-time SDK initialization:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> ~~~{.cpp}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> // Parameters for one-time initialization.</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> InitializationSettings settings;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> // The folder in which the license is stored.</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> settings.licenseStore("license");</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> // Initializes all Handler services explicitly.</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> OnixS::CME::MDH::initialize(settings);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> ~~~</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> \section constructing-handler-instance Configuring and Constructing the Handler</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> The OnixS::CME::MDH::Handler class incapsulates a market data processing </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> machinery. A single instance of the OnixS::CME::MDH::Handler processes </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> market data for a single CME channel.</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> The users must define settings affecting market data processing behavior </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> before constructing an instance of the OnixS::CME::MDH::Handler class.</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> The OnixS::CME::MDH::HandlerSettings class contains all parameters </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> controlling various aspects of market data processing including </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> the behavior of the OnixS::CME::MDH::Handler. </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> In the most cases, default values are set for parameters defining </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> the most likely behavior of the OnixS::CME::MDH::Handler instance. </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> However, some parameters must be set explicitly before constructing </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> an instance of the OnixS::CME::MDH::Handler class.</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> ~~~{.cpp}</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> HandlerSettings settings;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> settings.channel(310);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> settings.</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  feeds().</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  connectivityConfigurationFile("config.xml");</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> Handler handler(settings);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> ~~~</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> See [Handler's Settings](\ref handler-settings) for more</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> information on adjusting behavior of the Handler.</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> \section binding-feedengine-to-handler Binding Feed Engine to the Handler</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> The OnixS::CME::MDH::FeedEngine class encapsulates a layer responsible for </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> receiving market data which is transmitted by the CME MDP. Therefore, to have</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> successful processing of market data, it is necessary to construct an instance </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> of the Feed Engine and to bind it to the previously constructed instance of </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> the OnixS::CME::MDH::Handler class:</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> ~~~{.cpp}</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> FeedEngineSettings feSettings;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> FeedEngine feedEngine(feSettings);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> handler.bindFeedEngine(feedEngine);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> ~~~</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> See [Feed Engine](\ref feed-engine) for more details on Feed Engine.</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> \note An instance of the OnixS::CME::MDH::Handler does not manage </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> lifetime of a bound OnixS::CME::MDH::FeedEngine instance. Therefore, </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> user responsibility is to keep an instance of the OnixS::CME::MDH::FeedEngine </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> class valid while it is bound to an instance of OnixS::CME::MDH::Handler class.</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> \section binding-logger-to-handler Logging Market Data and Other Events (Optional)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> The Handler may log market data it processes for further use by </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> replay feature or analysis as well as other important events which </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> may take place during regular market data processing.</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> The OnixS::CME::MDH::Logger abstract class encapsulates the </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> logging subsystem. The SDK provides various implementations </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> of logging for different purposes. File-based logging is </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> satisfactory choise for the most cases.</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> Below is an example of how file based logging can be established:</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> ~~~{.cpp}</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> FileLoggerSettings loggerSettings;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> // Sets filename of log as it was used by older Handlers.</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> loggerSettings.filename(makeLogFilename(310));</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> // Varies which events are to be logged.</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> loggerSettings.severityLevel(LogSeverity::Debug);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> FileLogger logger(loggerSettings);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> handler.bindLogger(logger);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> ~~~</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> \note An instance of the OnixS::CME::MDH::Handler does not manage </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> lifetime of a bound OnixS::CME::MDH::Logger instance. Therefore, </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> user responsibility is to keep an instance of the OnixS::CME::MDH::Logger </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> class valid while it is bound to an instance of OnixS::CME::MDH::Handler class.</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> \section registering-listeners-with-handler Subscribing to Market Data Events</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> Once an instance of the OnixS::CME::MDH::Handler is constructed </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> and bound to an instance of the OnixS::CME::MDH::FeedEngine, market </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> data processing can be started. However, it's necessary to subscribe </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> to corresponding events to get the results of market data processing </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> like updated order books.</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> See the [Event Listeners](\ref event-listeners) topic concerning which </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> events are exposed by the Handler and how to subscribe to a particular </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> event.</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> \section spawning-md-processing Spawning Market Data Processing</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> As soon as an instance of the OnixS::CME::MDH::Handler is configured, </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> bound to a valid instance of the OnixS::CME::MDH::FeedEngine and listeners </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> for events are registered, market data processing can be initiated.</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> Market data processing is initiated by invoking the OnixS::CME::MDH::Handler::start </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> member, which accepts an instance of OnixS::CME::MDH::SessionSettings class defining</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> the behavior of the Handler for the session.</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> For the most common processing scenarios, the SDK exposes ready-to-use</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> presets of session settings: OnixS::CME::MDH::AccurateLateJoinSession(),</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> OnixS::CME::MDH::AccuratePreopeningSession, OnixS::CME::MDH::NaturalRefreshSession,</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> etc. See documentation for noted classes for more details.</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> ~~~{.cpp}</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> handler.start(AccurateLateJoinSession());</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> ~~~</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> The OnixS::CME::MDH::Handler::stop member must be </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> called to accomplish live market data processing:</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> ~~~{.cpp}</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> handler.stop();</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> ~~~</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> \note For more and up-to-date information on getting started aspects,</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> see __GettingStarted__ sample from the samples collection available in</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> distributive package.</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>
|