82 lines
14 KiB
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/ReplayingLogFiles.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/ReplayingLogFiles.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ReplayingLogFiles_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 log-replay</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 previously recorded logs can be used </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> as source of market data for further testing or analysis. </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 replaying-logs Using Logs to Replay Market Data</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> Under normal flow, the Handler logs all important aspects </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> of its execution. Logged events also include the original </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> market data processed by the Handler. Development and support </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> teams may use this information during investigations of non-standard </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> situations. However, it can be used to reproduce normal Handler's </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> behavior for a certain period of time.</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 Handler can extract market data from a log file </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> if the OnixS::CME::MDH::FileLogger produced it. </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> \warning To get market data recorded into a log file, the </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> OnixS::CME::MDH::FileLoggerSettings::severityLevel parameter </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> must be set to either the OnixS::CME::MDH::LogSeverity::Regular </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> or the OnixS::CME::MDH::LogSeverity::Debug value. Otherwise,</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> Handler triggers no market-related events due to absense of</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> a source for those events. </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> Market data replay can be done with the help of the </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> OnixS::CME::MDH::Handler::replay member. It accepts </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> an instance of OnixS::CME::MDH::ReplaySettings class </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> containing a list of logs for replay.</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> A collection of log files to replay can be either assigned </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> manually or fulfilled using utility routines provided by the </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> SDK if log files were recorded using standard naming conventions</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> used by the SDK and the OnixS::CME::MDH::FileLogger in particular.</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> ~~~{.cpp}</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> ReplaySettings replaySettings;</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> // Collects all log files recorded for</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> // channel 310 and stored in logStore folder.</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> gatherLogFiles(</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  replaySettings.logs(),</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  310,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  "logStore");</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> handler.replay(replaySettings);</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> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> Alternatively, it is possible to define a list of log files manually. </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> A manually manipulated list of log files allows replaying log files </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> which names differ from the names used by the Handler.</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> ReplaySettings replaySettings;</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> replaySettings.logs().push_back("1.txt");</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> replaySettings.logs().push_back("2.txt");</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> replaySettings.logs().push_back("3.txt");</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> ~~~</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> \note Files to be replayed must be in exact order as they were </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> recorded by the Handler in bounds of a single processing session.</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> \note In contrast to the previous major versions, the Handler </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> performs a log file replay synchronously. As a result, the </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> OnixS::CME::MDH::Handler::replay does not return the control </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> to the caller unless entire data is replayed. The given approach </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> simplifies detection of the end of the replay. </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> From the event invocation perspective, there's no difference whether </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> the Handler processes market received by the network or from a log file.</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> \note In case of live market data processing, the Handler raises events</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> that reflect processing results as soon as market data is received from</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> the network and processed. However, the MDP spreads market data with different</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> frequency, which depends on live market activity. Therefore, there're delays</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> of different duration between triggered events. When the Handler replays </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> a log file, it does not do any pauses between data items, and thus, </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> it raises corresponding events as soon as data is retrieved from that </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> log file.</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> During the replay, the OnixS::CME::MDH::PacketArgs::receiveTime member </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> returns original time when market data packet was obtained from the network.</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> \note Currently, log replay must be run with the same set of the </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> Handler's settings which were originally used.</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> A sample application demonstrating a Log Replay feature can be found </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> in the samples/LogReplay subfolder of the SDK 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>
|