Files
externals/linux/doc/Onixs.ICE.3.13.0.0/html/group__getting_started.html
2019-02-11 13:31:08 -05:00

89 lines
6.5 KiB
HTML

<!-- HTML header for doxygen 1.8.7-->
<!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 ICE iMpact Multicast Feed Handler for C++: Getting Started</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"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.gif"/></a></td>
<td style="padding-left: 0.5em;">
<div id="projectname">OnixS ICE iMpact Multicast Feed Handler for C++
&#160;<span id="projectnumber">3.13.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</header>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">Getting Started</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__product_definitions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__product_definitions.html">Product Definitions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__making_subscription"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__making_subscription.html">Subscribing to multicast groups</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__selecting_securities_of_interest"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__selecting_securities_of_interest.html">Selecting Securities of Interest</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__event_listeners"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__event_listeners.html">Listening to Handler's events</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__book_handling"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__book_handling.html">Manipulating market books</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__error_handling"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__error_handling.html">Error handling and recovering</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__understanding_handler_states"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__understanding_handler_states.html">Understanding Handler States</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__threading_model"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__threading_model.html">Threading Model</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>All Handler classes are located under the OnixS::ICE::iMpact namespace. Header files are assembled in the <code>"OnixS/ICE/iMpact/MarketData.h"</code> header file.</p>
<p>The typical way of using the Handler is as follows:</p>
<ul>
<li>Optionally create an instance of <a class="el" href="struct_onix_s_1_1_i_c_e_1_1i_mpact_1_1_market_data_1_1_handler_settings.html" title="Defines set of settings which affect behavior of the Handler. ">OnixS::ICE::iMpact::MarketData::HandlerSettings</a> class to adjust Handler's options like activating logging.</li>
<li>Create an instance of <a class="el" href="class_onix_s_1_1_i_c_e_1_1i_mpact_1_1_market_data_1_1_handler.html" title="Manipulates ICE iMpact Multicast Price Feeds. ">OnixS::ICE::iMpact::MarketData::Handler</a> class.</li>
<li>Register listener for errors to be notified about failures occurred while processing market data from multicast channels.</li>
<li>Register listeners for miscellaneous events like product definition reception and/or changes in market state.</li>
<li>Create an subscription for interested markets by forming OnixS::ICE::iMpact::MarketData::MarketSubscriptions collection.</li>
<li>Start subscription by invoking <a class="el" href="class_onix_s_1_1_i_c_e_1_1i_mpact_1_1_market_data_1_1_handler.html#aecfeb158f2b3d60cbe8773f819b4caeb" title="Subscribes to the given market. ">OnixS::ICE::iMpact::MarketData::Handler::start</a> member and supplying previously created collection of subscriptions as a parameter.</li>
<li>Process changes in books and markets states through previously registered listeners.</li>
<li>Stop subscription using the <a class="el" href="class_onix_s_1_1_i_c_e_1_1i_mpact_1_1_market_data_1_1_handler.html#a8c528baf37154d347366083f0f816846" title="Interrupts all subscriptions. ">OnixS::ICE::iMpact::MarketData::Handler::stop</a> member. </li>
</ul>
</div><!-- contents -->
</ul>
<hr class="footer"/><address class="footer"><small>&copy; <a href="http://www.onixs.biz">Onix Solutions [OnixS]</a>. All rights reserved.</small></address>
</div>
</body>
</html>