82 lines
19 KiB
HTML
82 lines
19 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/SelectingSecuritiesOfInterest.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/SelectingSecuritiesOfInterest.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="SelectingSecuritiesOfInterest_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 security-selection </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 Provides information on how to make Handler raise </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> security-related events for particular securities only. </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> \section define-security-selection Defining Securities of Interest</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> By default, the Handler processes market data for all securities available </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> in a particular market data channel. For certain channels, it may be a huge </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> amount of data which may cause the Handler to allocate a significant amount </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> of system resources (like a memory). From the other side, it often happens </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> that not all securities are the point of interest. For these reasons, the </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> Handler provides an ability to define a subset of securities for which it </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> monitors market data, maintains books and report about other market-related </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> events. The Handler fires no events for any security not present in the </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> defined subset. This feature is called *selecting securities or security </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> filtering*.</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> Selecting securities is similar to the process of filling a bag with </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> apples. The OnixS::CME::MDH::InstrumentSelection class must be used to </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> gather securities into a collection for which the Handler must process </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> market data. There're no limits on the quantity of securities which can </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> be included into the selection.</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> If at least one security is added to the filter, the Handler stops </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> raising events for all securities available in the market data channel. </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> Since that moment the Handler fires events only for securities included </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> in filtering.</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> Securities can be filtered using security id, security group, </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> symbol, and asset attributes. For each of these attributes, the </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> OnixS::CME::MDH::InstrumentSelection class exposes the corresponding </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> member returning a collection of attribute values which can be </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> manipulated as the regular std::set.</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> An empty (blank) security selection causes the Handler to process </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> market data and to trigger events for all securities on the channel.</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> \note Selecting securities affects the OnixS::CME::MDH::SecurityListener </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> listener only. The Handler does not invoke listener members for securities </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> out of the selection scope. Other listeners are not affected by this feature.</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> \warning **Filtering must be manipulated only when the </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> Handler is not processing market data or in bounds of the </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> OnixS::CME::MDH::HandlerListener::onEndOfInstrumentRecovery</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> callback with a successful recovery status. Once the Handler </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> begins market data processing or moves out of the noted callback </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> scope, security selection must not be modified.**</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 security-filter-example Example</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 following code demonstrates how to instruct the Handler</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> to process data only for securities selected by the user:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> ~~~{.cpp}</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> using namespace OnixS::CME::MDH;</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> class</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> InteractiveSecuritySelector</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> : public SecurityListener</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> , public HandlerListener</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  InstrumentSelection selection_;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  template</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>  class Definition</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>  bool</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  userSelectedSecurity(</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  const Definition& definition)</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>  // Given member asks user whether user wants</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  // to have market data for given instrument.</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  // Returned value indicates whether user</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  // selected instrument.</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  return true;</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> public:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  InteractiveSecuritySelector()</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>  }</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>  void</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  onDefinition(</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  Handler&,</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  const Security& security,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  const InstrumentDefinitionFutureArgs& args)</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>  if (userSelectedSecurity(args.message())</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  selection_.securityIds().insert(security.id());</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> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  void</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  onDefinition(</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  Handler&,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  const Security& security,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  const InstrumentDefinitionSpreadArgs& args)</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>  if (userSelectedSecurity(args.message())</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  selection_.securityIds().insert(security.id());</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> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  void</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  onDefinition(</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  Handler&,</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  const Security& security,</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  const InstrumentDefinitionOptionArgs& args)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  if (userSelectedSecurity(args.message())</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  selection_.securityIds().insert(security.id());</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> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  void</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  onEndOfInstrumentRecovery(</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  Handler& handler,</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  const RecoveryCompletionArgs& args)</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  if (args.status() ==</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  RecoveryCompletionStatus::Succeeded)</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>  handler.selectInstruments(selection_);</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>  }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> };</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> Handler handler(settings);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> InteractiveSecuritySelector selector;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> handler.registerSecurityListener(selector);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> handler.registerListener(selector);</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> handler.start();</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> ~~~</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>
|