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

82 lines
14 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/ManipulatingBooks.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/ManipulatingBooks.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="ManipulatingBooks_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 book-handling</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 order book machinery. </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;\section book-manipulations Order Books in the SDK</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;CME MDP maintains market by price (price-level) and market by order </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;books. There are several types of books available for each security: </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;**Market By Order (MBO)**, **Direct**, **Implied** and **Consolidated**. </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;The SDK exposes the corresponding class for each of book type: </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;OnixS::CME::MDH::MboBook, OnixS::CME::MDH::DirectBook, </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;OnixS::CME::MDH::ImpliedBook and OnixS::CME::MDH::ConsolidatedBook. </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;Each class exposes exact data available for a particular kind of </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;the order book.</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;\note Although there are four different types of books, MDP</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;transmits data for only **MBO**, **direct** and **implied** types</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;of books. **Consolidated** books are being maintained by the Handler</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;locally using instances of **direct** and **implied** books</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;for a particular security.</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;The Handler notifies a client code through the </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;OnixS::CME::MDH::SecurityListener::onBookUpdate callback</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;once a book of any type and for any security is updated. </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;For market by price (MBP) books which **direct**, **implied** and **consolidated**</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;books are, the depth of book of a particular type is usually defined by security</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;definition and is exposed by the OnixS::CME::MDH::MbpBook::depth member. The returned </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;value defines the maximum number of price levels which may exist in the book.</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;OnixS::CME::MDH::MbpBook::bids and OnixS::CME::MDH::MbpBook::asks</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;members of the OnixS::CME::MDH::MbpBook class can be used to access</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;price value and quantity information for all levels available in the book.</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;Similarly, interface of class gathering MBO book data includes</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;OnixS::CME::MDH::MboBook::bids and OnixS::CME::MDH::MboBook::asks</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;members to access details for all orders available in the book.</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;Also, order book maintenance is now explicitly defined by the Handler</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;configuration. </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;The following code sample defines how to manage </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;maintenance of order books using Handler settings:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;~~~{.cpp}</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;HandlerSettings settings;</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;// Let Handler to maintain direct books. Once parameter is set </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;// to &#39;true&#39;, Handler will invoke SecurityListener::onBookUpdate() </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;// member passing instance of a valid direct book.</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;settings.bookManagement().directBooks().maintain(true);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;// Given statement suppresses implied order book maintenance.</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;// However, if consolidated order book maintenance is enabled,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;// implied order book will also be maintained. Therefore, given</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;// statement only suppresses order book update event triggering.</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;settings.bookManagement().impliedBooks().maintain(false);</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;// Let Handler to maintain consolidated books. Once parameter</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;// is set to &#39;true&#39;, Handler will invoke SecurityListener::onBookUpdate()</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;// member passing instance of a valid consolidated book.</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;settings.bookManagement().consolidatedBooks().maintain(true);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;~~~</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;Depth of a MBP book of a particular type is usually defined by</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;security definition and is exposed by OnixS::CME::MDH::Book::depth</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;member. Returned value defines maximum number of price levels which</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;may exist in a particular book instance.</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::MDH::Book::bids and OnixS::CME::MDH::Book::offers</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;members of the OnixS::CME::MDH::Book class can be used to access</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;price value and quantity information for all levels available in</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;the book.</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;\section behavior-traits Behavioral Traits</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;The Handler constructs books for each security since the moment it receives</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;a definition for that security. **Books are changed in time, and their members </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;are not thread-safe**. The Handler uses own synchronization strategies while </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;updating the books. Therefore, **do not access price levels information outside </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;of book-related event handling** as well as **do not store references to any </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;book instance and data returned by its members** like asks and bids collections. </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;This restriction exists because the Handler may change internal book structures </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;at the same time. **If any data exposed by the OnixS::CME::MDH::Book class instance </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;must be used outside of event handling, it must be copied before later use**. </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;\see \ref book-construction-and-copying, OnixS::CME::MDH::SecurityListener</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>