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

82 lines
11 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/AdjustingSettings.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/AdjustingSettings.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="AdjustingSettings_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 handler-settings</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 Describes primary aspects of configuring the Handler. </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;OnixS::CME::MDH::Handler constructor accepts an instance of the</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;OnixS::CME::MDH::HandlerSettings class which defines values for</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;various parameters which affect Handler&#39;s behavior. Below sections</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;describe the role of the most important parameters used in usual </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;cases.</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;\section channel-id Market Data Channel</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;CME market data is distributed across multiple logical units to </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;reduce network and client system load. These logical units are </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;called as channels. OnixS::CME::MDH::Handler designed to process </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;market data transmitted in bounds of single CME channel. Therefore, </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;it requires channel identifier whose market data will be processed. </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;OnixS::CME::MDH::HandlerSettings class exposes </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;OnixS::CME::MDH::HandlerSettings::channel parameter to instruct </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;the Handler market data of which channel must be processed.</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;\section configuration-file Connectivity Configuration</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;The Handler requires connectivity configuration, if it must process </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;market data from the live Market Data Platform. Data stored in this </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;configuration is used by the Handler to identify network connectivity </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;attributes for a particular market data channel.</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;\note Market data configuration provided by the CME Group and available</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;on their public FTP servers. *CME Group updates market data configuration</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;on regular (weekly) basis*. Visit the [CME Market Data Platform Wiki][wiki]</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;for more information about configuration updating schedule as well as how to</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;access public FTP servers.</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;A OnixS::CME::MDH::FeedSettings returned by the OnixS::CME::MDH::HandlerSettings::feeds</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;exposes the OnixS::CME::MDH::FeedSettings::connectivityConfigurationFile member which</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;can be used to set the path to the locally stored copy of such configuration file.</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;\warning Single market data configuration file contains settings for all market</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;data channels. However, CME Group uses different market data configurations for</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;different environments (like Production and Certification environments). Multiple</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;instances of the OnixS::CME::MDH::Handler class can be initialized to use either</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;single or different market data configurations. In other words, there are no </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;problems to use multiple instances of the Handler to connect to different</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;environments.</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;\section primary-settings Primary Settings Groups</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;Previously, all parameters affecting Handler behavior were placed at the same level</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;thus making it difficult to navigate and explore. Starting from version 4.0 all parameters</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;are logically divided into groups:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;| Group and Access Member | Description |</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;|---|---|</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;| OnixS::CME::MDH::HandlerSettings::feeds | Given section contains all parameters affecting multicast and TCP feeds behavior used by Handler while processing market data from CME MDP. |</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;| OnixS::CME::MDH::HandlerSettings::tradeProcessing | Encapsulates all trade-related settings and policies. |</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;| OnixS::CME::MDH::HandlerSettings::bookManagement | Parameters affecting order book maintenance. |</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;| OnixS::CME::MDH::HandlerSettings::debugLogging | Parameters identifying information logged in debug mode. |</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;[wiki]: http://www.cmegroup.com/confluence/display/EPICSANDBOX/CME+MDP+3.0+Market+Data</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>