82 lines
11 KiB
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/CloningBooks.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/CloningBooks.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="CloningBooks_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 book-construction-and-copying</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 Explains how to construct instances of </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> order books and to copy content across books. </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> Although the Handler constructs and updates order books </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> internally exposing already ready-to-use instances of books </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> through callbacks, SDK provides the ability to construct and </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> manipulate order books by users. </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> \section book-factory Constructing Book Instances</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> There're two types of books exposed by SDK: *MBO* (Market By Order) </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> and *MBP* (Market By Price). The last one in its turn consists of </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> three types: *Direct*, *Implied*, *Consolidated*. For each type of books, </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> the Handler provides instance constructing patterns. </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> \subsection mbp-book-factory Constructing MBP (Market By Price) Books</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> MBP books are limited in size (depth). CME MDP provides information on </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> book depth in instrument definitions. Therefore, the Handler knowns the </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> book depth as soon as it receives a definition for a security.</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> To make book operations efficient, SDK optimizes memory allocation </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> and data layout for MBP books. Therefore, construction of MBP books </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> and further lifetime management are performed through the use of </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> special factory classes. The Table below maps factory-classes to </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> corresponding book types.</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> | Book Class | Factory Class | </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> |------------------|-------------------------|</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> | DirectBook | DirectBookFactory | </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> | ImpliedBook | ImpliedBookFactory | </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> | ConsolidatedBook | ConsolidatedBookFactory | </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> Each of factory classes, in fact, represents an instantiation of </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> the OnixS::CME::MDH::MbpBookFactory template class which provides </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> the following key members:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> | Member | Description | </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> | OnixS::CME::MDH::MbpBookFactory::construct | Constructs an instance of book of a particular type. |</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> | OnixS::CME::MDH::MbpBookFactory::destruct | Destroys an instance of the book of a particular type and disposes all allocated resources. |</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> | OnixS::CME::MDH::MbpBookFactory::calcSize | Calculates the size of memory block required to store an instance of the book of a given depth. |</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> | OnixS::CME::MDH::MbpBookFactory::inplaceConstruct | Constructs an instance of book in place of a given memory block. |</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> \subsection mbo-book-factory Constructing MBO (Market By Order) Books</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> MBO books in contrast to MBP ones are not limited by depth and may </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> contain an arbitrary number of bids and offers. Therefore, an instance of </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> the book cannot be placed in a flat memory block of fixed size. For this </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> reason, there's no factory class constructing MBO book instances using </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> special memory layout. Instead, the instances of the OnixS::CME::MDH::MboBook </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> class are constructed in an ordinary way.</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> \section book-copying Coping Book Content</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> The SDK offers the OnixS::CME::MDH::copy routine </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> to copy a book content across instances. </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> A template version of given routine copies a price level and other data </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> for MBP books. Also, the routine has an optional parameter which allows </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> limiting a number of price levels to copy. </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> Overload of the OnixS::CME::MDH::copy routine for MBO books represents </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> a wrapper over the OnixS::CME::MDH::MboBook assignment operator. </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>
|