mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
562 lines
46 KiB
HTML
562 lines
46 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fair::mq Namespace Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.4.33</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>fair</b></li><li class="navelem"><a class="el" href="namespacefair_1_1mq.html">mq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fair::mq Namespace Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Tools for interfacing containers to the transport via polymorphic allocators.
|
|
<a href="namespacefair_1_1mq.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespacefair_1_1mq_1_1shmem"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefair_1_1mq_1_1shmem.html">shmem</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1Alignment.html">Alignment</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ChannelResource.html">ChannelResource</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1DeviceErrorState.html">DeviceErrorState</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Utility class to facilitate a convenient top-level device launch/shutdown. <a href="classfair_1_1mq_1_1DeviceRunner.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1ErrorCategory.html">ErrorCategory</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1Event.html">Event</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1EventManager.html">EventManager</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Manages event callbacks from different subscribers. <a href="classfair_1_1mq_1_1EventManager.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1FairMQMemoryResource.html">FairMQMemoryResource</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1MessageBadAlloc.html">MessageBadAlloc</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1MessageError.html">MessageError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1OngoingTransition.html">OngoingTransition</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1ParserError.html">ParserError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1Plugin.html">Plugin</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for FairMQ plugins. <a href="classfair_1_1mq_1_1Plugin.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1PluginManager.html">PluginManager</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">manages and owns plugin instances <a href="classfair_1_1mq_1_1PluginManager.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Facilitates communication between devices and plugins. <a href="classfair_1_1mq_1_1PluginServices.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PollerError.html">PollerError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PropertyChange.html">PropertyChange</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PropertyChangeAsString.html">PropertyChangeAsString</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1PropertyHelper.html">PropertyHelper</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PropertyNotFoundError.html">PropertyNotFoundError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1SocketError.html">SocketError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1StateMachine.html">StateMachine</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1StateQueue.html">StateQueue</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1TransportError.html">TransportError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1TransportFactoryError.html">TransportFactoryError</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a88137ad3f7b708242e0da109a88233a4"><td class="memItemLeft" align="right" valign="top"><a id="a88137ad3f7b708242e0da109a88233a4"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>Message</b> = <a class="el" href="classFairMQMessage.html">FairMQMessage</a></td></tr>
|
|
<tr class="separator:a88137ad3f7b708242e0da109a88233a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d535e40ca4414411799567d49ac738e"><td class="memItemLeft" align="right" valign="top"><a id="a2d535e40ca4414411799567d49ac738e"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>MessagePtr</b> = FairMQMessagePtr</td></tr>
|
|
<tr class="separator:a2d535e40ca4414411799567d49ac738e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a177478f987dabbffbc33d6abc3f421d4"><td class="memItemLeft" align="right" valign="top"><a id="a177478f987dabbffbc33d6abc3f421d4"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>Poller</b> = <a class="el" href="classFairMQPoller.html">FairMQPoller</a></td></tr>
|
|
<tr class="separator:a177478f987dabbffbc33d6abc3f421d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7744bcd9dbc07cb565989b138a438eb6"><td class="memItemLeft" align="right" valign="top"><a id="a7744bcd9dbc07cb565989b138a438eb6"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>PollerPtr</b> = FairMQPollerPtr</td></tr>
|
|
<tr class="separator:a7744bcd9dbc07cb565989b138a438eb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb43bc2ce2e5b4671f9360f45c7f9252"><td class="memItemLeft" align="right" valign="top"><a id="aeb43bc2ce2e5b4671f9360f45c7f9252"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>Socket</b> = <a class="el" href="classFairMQSocket.html">FairMQSocket</a></td></tr>
|
|
<tr class="separator:aeb43bc2ce2e5b4671f9360f45c7f9252"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429a944de3d76d43f9c4b6b99e4669b4"><td class="memItemLeft" align="right" valign="top"><a id="a429a944de3d76d43f9c4b6b99e4669b4"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>SocketPtr</b> = FairMQSocketPtr</td></tr>
|
|
<tr class="separator:a429a944de3d76d43f9c4b6b99e4669b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a7baa0a922dc945d3c0d2bed58e627b"><td class="memItemLeft" align="right" valign="top"><a id="a5a7baa0a922dc945d3c0d2bed58e627b"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>TransportFactory</b> = <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a></td></tr>
|
|
<tr class="separator:a5a7baa0a922dc945d3c0d2bed58e627b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7096042d3a795a1ed598a5d2e7f4f628"><td class="memItemLeft" align="right" valign="top"><a id="a7096042d3a795a1ed598a5d2e7f4f628"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>RegionCallback</b> = FairMQRegionCallback</td></tr>
|
|
<tr class="separator:a7096042d3a795a1ed598a5d2e7f4f628"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9cbf41c9da378d9494ee988c4fd0d1b"><td class="memItemLeft" align="right" valign="top"><a id="ac9cbf41c9da378d9494ee988c4fd0d1b"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>RegionBulkCallback</b> = FairMQRegionBulkCallback</td></tr>
|
|
<tr class="separator:ac9cbf41c9da378d9494ee988c4fd0d1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48741e0c2f3150070ff7fadc1dd8503b"><td class="memItemLeft" align="right" valign="top"><a id="a48741e0c2f3150070ff7fadc1dd8503b"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>RegionEventCallback</b> = FairMQRegionEventCallback</td></tr>
|
|
<tr class="separator:a48741e0c2f3150070ff7fadc1dd8503b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60b1bd6e95e25e4c15b074ce58ba9150"><td class="memItemLeft" align="right" valign="top"><a id="a60b1bd6e95e25e4c15b074ce58ba9150"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>RegionEvent</b> = FairMQRegionEvent</td></tr>
|
|
<tr class="separator:a60b1bd6e95e25e4c15b074ce58ba9150"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47ddc0fe1bd46c2df4adcd3a253fa936"><td class="memItemLeft" align="right" valign="top"><a id="a47ddc0fe1bd46c2df4adcd3a253fa936"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>RegionInfo</b> = <a class="el" href="structFairMQRegionInfo.html">FairMQRegionInfo</a></td></tr>
|
|
<tr class="separator:a47ddc0fe1bd46c2df4adcd3a253fa936"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e021c77d4eefcefe4ae814388c0fadc"><td class="memItemLeft" align="right" valign="top"><a id="a0e021c77d4eefcefe4ae814388c0fadc"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>RegionBlock</b> = <a class="el" href="structFairMQRegionBlock.html">FairMQRegionBlock</a></td></tr>
|
|
<tr class="separator:a0e021c77d4eefcefe4ae814388c0fadc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe7b15e50c5af21b93033a7b80816541"><td class="memItemLeft" align="right" valign="top"><a id="afe7b15e50c5af21b93033a7b80816541"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>UnmanagedRegion</b> = <a class="el" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a></td></tr>
|
|
<tr class="separator:afe7b15e50c5af21b93033a7b80816541"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb3d9a149a4fe8383af719e44fa56158"><td class="memItemLeft" align="right" valign="top"><a id="acb3d9a149a4fe8383af719e44fa56158"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>UnmanagedRegionPtr</b> = FairMQUnmanagedRegionPtr</td></tr>
|
|
<tr class="separator:acb3d9a149a4fe8383af719e44fa56158"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06fc774ca164422937fd52960283aca8"><td class="memItemLeft" align="right" valign="top"><a id="a06fc774ca164422937fd52960283aca8"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>byte</b> = unsigned char</td></tr>
|
|
<tr class="separator:a06fc774ca164422937fd52960283aca8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa586d2426dd772d0c36751dc9c96fa86"><td class="memItemLeft" align="right" valign="top"><a id="aa586d2426dd772d0c36751dc9c96fa86"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>BytePmrAllocator</b> = pmr::polymorphic_allocator< fair::mq::byte ></td></tr>
|
|
<tr class="separator:aa586d2426dd772d0c36751dc9c96fa86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaee6639d7eb6402d4d7ea564232a9483"><td class="memItemLeft" align="right" valign="top"><a id="aaee6639d7eb6402d4d7ea564232a9483"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>Property</b> = boost::any</td></tr>
|
|
<tr class="separator:aaee6639d7eb6402d4d7ea564232a9483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e7b49751d96e7eefe44e433c31bb0c7"><td class="memItemLeft" align="right" valign="top"><a id="a9e7b49751d96e7eefe44e433c31bb0c7"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>Properties</b> = std::map< std::string, Property ></td></tr>
|
|
<tr class="separator:a9e7b49751d96e7eefe44e433c31bb0c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ad8fc2351f2b3dd4be183b027f8ec8b5c"><td class="memItemLeft" align="right" valign="top"><a id="ad8fc2351f2b3dd4be183b027f8ec8b5c"></a>enum  </td><td class="memItemRight" valign="bottom"><b>TransferCode</b> : int { <b>success</b> = 0,
|
|
<b>error</b> = -1,
|
|
<b>timeout</b> = -2,
|
|
<b>interrupted</b> = -3
|
|
}</td></tr>
|
|
<tr class="separator:ad8fc2351f2b3dd4be183b027f8ec8b5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4d50e64053ef18a73a02db421552aa8"><td class="memItemLeft" align="right" valign="top"><a id="ad4d50e64053ef18a73a02db421552aa8"></a>enum  </td><td class="memItemRight" valign="bottom"><b>ErrorCode</b> { <br />
|
|
  <b>OperationInProgress</b> = 10,
|
|
<b>OperationTimeout</b>,
|
|
<b>OperationCanceled</b>,
|
|
<b>DeviceChangeStateFailed</b>,
|
|
<br />
|
|
  <b>DeviceGetPropertiesFailed</b>,
|
|
<b>DeviceSetPropertiesFailed</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ad4d50e64053ef18a73a02db421552aa8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0adc63dc1325d994eebf10d12a41f28"><td class="memItemLeft" align="right" valign="top"><a id="ac0adc63dc1325d994eebf10d12a41f28"></a>enum  </td><td class="memItemRight" valign="bottom"><b>State</b> : int { <br />
|
|
  <b>Undefined</b> = 0,
|
|
<b>Ok</b>,
|
|
<b>Error</b>,
|
|
<b>Idle</b>,
|
|
<br />
|
|
  <b>InitializingDevice</b>,
|
|
<b>Initialized</b>,
|
|
<b>Binding</b>,
|
|
<b>Bound</b>,
|
|
<br />
|
|
  <b>Connecting</b>,
|
|
<b>DeviceReady</b>,
|
|
<b>InitializingTask</b>,
|
|
<b>Ready</b>,
|
|
<br />
|
|
  <b>Running</b>,
|
|
<b>ResettingTask</b>,
|
|
<b>ResettingDevice</b>,
|
|
<b>Exiting</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ac0adc63dc1325d994eebf10d12a41f28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abde5bfc937080eb43169f37768fc46d8"><td class="memItemLeft" align="right" valign="top"><a id="abde5bfc937080eb43169f37768fc46d8"></a>enum  </td><td class="memItemRight" valign="bottom"><b>Transition</b> : int { <br />
|
|
  <b>Auto</b> = 0,
|
|
<b>InitDevice</b>,
|
|
<b>CompleteInit</b>,
|
|
<b>Bind</b>,
|
|
<br />
|
|
  <b>Connect</b>,
|
|
<b>InitTask</b>,
|
|
<b>Run</b>,
|
|
<b>Stop</b>,
|
|
<br />
|
|
  <b>ResetTask</b>,
|
|
<b>ResetDevice</b>,
|
|
<b>End</b>,
|
|
<b>ErrorFound</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:abde5bfc937080eb43169f37768fc46d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52eadbe26f86865bc788dec7dff08530"><td class="memItemLeft" align="right" valign="top"><a id="a52eadbe26f86865bc788dec7dff08530"></a>enum  </td><td class="memItemRight" valign="bottom"><b>channelOptionKeyIds</b> { <br />
|
|
  <b>NAME</b> = 0,
|
|
<b>TYPE</b>,
|
|
<b>METHOD</b>,
|
|
<b>ADDRESS</b>,
|
|
<br />
|
|
  <b>TRANSPORT</b>,
|
|
<b>SNDBUFSIZE</b>,
|
|
<b>RCVBUFSIZE</b>,
|
|
<b>SNDKERNELSIZE</b>,
|
|
<br />
|
|
  <b>RCVKERNELSIZE</b>,
|
|
<b>LINGER</b>,
|
|
<b>RATELOGGING</b>,
|
|
<b>PORTRANGEMIN</b>,
|
|
<br />
|
|
  <b>PORTRANGEMAX</b>,
|
|
<b>AUTOBIND</b>,
|
|
<b>NUMSOCKETS</b>,
|
|
<b>lastsocketkey</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a52eadbe26f86865bc788dec7dff08530"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae28f1b38bb71e36d5908ab14c77dc7ec"><td class="memItemLeft" align="right" valign="top"><a id="ae28f1b38bb71e36d5908ab14c77dc7ec"></a>enum  </td><td class="memItemRight" valign="bottom"><b>Transport</b> { <b>DEFAULT</b>,
|
|
<b>ZMQ</b>,
|
|
<b>SHM</b>,
|
|
<b>OFI</b>
|
|
}</td></tr>
|
|
<tr class="separator:ae28f1b38bb71e36d5908ab14c77dc7ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a6884b5bf50e31dde35d661eecc673bae"><td class="memItemLeft" align="right" valign="top"><a id="a6884b5bf50e31dde35d661eecc673bae"></a>
|
|
fair::mq::Properties </td><td class="memItemRight" valign="bottom"><b>PtreeParser</b> (const ptree &pt, const string &id)</td></tr>
|
|
<tr class="separator:a6884b5bf50e31dde35d661eecc673bae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dbfe0bee11154e90c16604df6168894"><td class="memItemLeft" align="right" valign="top"><a id="a6dbfe0bee11154e90c16604df6168894"></a>
|
|
fair::mq::Properties </td><td class="memItemRight" valign="bottom"><b>JSONParser</b> (const string &filename, const string &deviceId)</td></tr>
|
|
<tr class="separator:a6dbfe0bee11154e90c16604df6168894"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8260d88dc013104642fd63ce5a09af77"><td class="memItemLeft" align="right" valign="top"><a id="a8260d88dc013104642fd63ce5a09af77"></a>
|
|
fair::mq::Properties </td><td class="memItemRight" valign="bottom"><b>PtreeParser</b> (const boost::property_tree::ptree &pt, const std::string &deviceId)</td></tr>
|
|
<tr class="separator:a8260d88dc013104642fd63ce5a09af77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0eb3d8d5ee733c34c792820b28f64cd9"><td class="memItemLeft" align="right" valign="top"><a id="a0eb3d8d5ee733c34c792820b28f64cd9"></a>
|
|
fair::mq::Properties </td><td class="memItemRight" valign="bottom"><b>JSONParser</b> (const std::string &filename, const std::string &deviceId)</td></tr>
|
|
<tr class="separator:a0eb3d8d5ee733c34c792820b28f64cd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04c9b91443824693c646e91cc2c18417"><td class="memTemplParams" colspan="2"><a id="a04c9b91443824693c646e91cc2c18417"></a>
|
|
template<typename ContainerT > </td></tr>
|
|
<tr class="memitem:a04c9b91443824693c646e91cc2c18417"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>getMessage</b> (ContainerT &&container_, <a class="el" href="classfair_1_1mq_1_1FairMQMemoryResource.html">FairMQMemoryResource</a> *targetResource=nullptr)</td></tr>
|
|
<tr class="separator:a04c9b91443824693c646e91cc2c18417"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac63ae859c78e04b981b433e1b25f6367"><td class="memItemLeft" align="right" valign="top"><a id="ac63ae859c78e04b981b433e1b25f6367"></a>
|
|
<a class="el" href="structValInfo.html">ValInfo</a> </td><td class="memItemRight" valign="bottom"><b>ConvertVarValToValInfo</b> (const po::variable_value &v)</td></tr>
|
|
<tr class="separator:ac63ae859c78e04b981b433e1b25f6367"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71ff999f98957d271dbf6b19b26e70a3"><td class="memItemLeft" align="right" valign="top"><a id="a71ff999f98957d271dbf6b19b26e70a3"></a>
|
|
string </td><td class="memItemRight" valign="bottom"><b>ConvertVarValToString</b> (const po::variable_value &v)</td></tr>
|
|
<tr class="separator:a71ff999f98957d271dbf6b19b26e70a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92b76f5342a0cc4957130d4a244dcb50"><td class="memTemplParams" colspan="2"><a id="a92b76f5342a0cc4957130d4a244dcb50"></a>
|
|
template<class T > </td></tr>
|
|
<tr class="memitem:a92b76f5342a0cc4957130d4a244dcb50"><td class="memTemplItemLeft" align="right" valign="top">ostream & </td><td class="memTemplItemRight" valign="bottom"><b>operator<<</b> (ostream &os, const vector< T > &v)</td></tr>
|
|
<tr class="separator:a92b76f5342a0cc4957130d4a244dcb50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cc0b3f82a8c1c46ac1d4828a5e54cec"><td class="memItemLeft" align="right" valign="top"><a id="a0cc0b3f82a8c1c46ac1d4828a5e54cec"></a>
|
|
ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (ostream &os, const vector< signed char > &v)</td></tr>
|
|
<tr class="separator:a0cc0b3f82a8c1c46ac1d4828a5e54cec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd3232f3ac8056ddd97ae038f54b6b18"><td class="memItemLeft" align="right" valign="top"><a id="abd3232f3ac8056ddd97ae038f54b6b18"></a>
|
|
ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (ostream &os, const vector< unsigned char > &v)</td></tr>
|
|
<tr class="separator:abd3232f3ac8056ddd97ae038f54b6b18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0dea8adf73fcddb6901f556ba39b3e34"><td class="memTemplParams" colspan="2"><a id="a0dea8adf73fcddb6901f556ba39b3e34"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a0dea8adf73fcddb6901f556ba39b3e34"><td class="memTemplItemLeft" align="right" valign="top">pair< string, string > </td><td class="memTemplItemRight" valign="bottom"><b>getString</b> (const boost::any &v, const string &label)</td></tr>
|
|
<tr class="separator:a0dea8adf73fcddb6901f556ba39b3e34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e0127cc8eda4d73bb0355f4eb8e3f5d"><td class="memTemplParams" colspan="2"><a id="a0e0127cc8eda4d73bb0355f4eb8e3f5d"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a0e0127cc8eda4d73bb0355f4eb8e3f5d"><td class="memTemplItemLeft" align="right" valign="top">pair< string, string > </td><td class="memTemplItemRight" valign="bottom"><b>getStringPair</b> (const boost::any &v, const string &label)</td></tr>
|
|
<tr class="separator:a0e0127cc8eda4d73bb0355f4eb8e3f5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01c7d9d61e36c0a4561ea05cc3dc68e2"><td class="memItemLeft" align="right" valign="top"><a id="a01c7d9d61e36c0a4561ea05cc3dc68e2"></a>
|
|
std::error_code </td><td class="memItemRight" valign="bottom"><b>MakeErrorCode</b> (ErrorCode e)</td></tr>
|
|
<tr class="separator:a01c7d9d61e36c0a4561ea05cc3dc68e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e8860b6cf3feef1e6afee3a85fb92d0"><td class="memItemLeft" align="right" valign="top"><a id="a0e8860b6cf3feef1e6afee3a85fb92d0"></a>
|
|
string </td><td class="memItemRight" valign="bottom"><b>GetStateName</b> (const State state)</td></tr>
|
|
<tr class="separator:a0e8860b6cf3feef1e6afee3a85fb92d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b6657e025a5c7d58bc3483ca84d80b0"><td class="memItemLeft" align="right" valign="top"><a id="a5b6657e025a5c7d58bc3483ca84d80b0"></a>
|
|
string </td><td class="memItemRight" valign="bottom"><b>GetTransitionName</b> (const Transition transition)</td></tr>
|
|
<tr class="separator:a5b6657e025a5c7d58bc3483ca84d80b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb8f93591b09c925509746567ec6c638"><td class="memItemLeft" align="right" valign="top"><a id="aeb8f93591b09c925509746567ec6c638"></a>
|
|
State </td><td class="memItemRight" valign="bottom"><b>GetState</b> (const string &state)</td></tr>
|
|
<tr class="separator:aeb8f93591b09c925509746567ec6c638"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace790fb6d2aba445a7f7ede872ca1b40"><td class="memItemLeft" align="right" valign="top"><a id="ace790fb6d2aba445a7f7ede872ca1b40"></a>
|
|
Transition </td><td class="memItemRight" valign="bottom"><b>GetTransition</b> (const string &transition)</td></tr>
|
|
<tr class="separator:ace790fb6d2aba445a7f7ede872ca1b40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af19642dca3e5d1d7144ad66397b44b4a"><td class="memItemLeft" align="right" valign="top"><a id="af19642dca3e5d1d7144ad66397b44b4a"></a>
|
|
State </td><td class="memItemRight" valign="bottom"><b>GetState</b> (const std::string &state)</td></tr>
|
|
<tr class="separator:af19642dca3e5d1d7144ad66397b44b4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d8d8907bf7b38d94ed80731547a7001"><td class="memItemLeft" align="right" valign="top"><a id="a5d8d8907bf7b38d94ed80731547a7001"></a>
|
|
Transition </td><td class="memItemRight" valign="bottom"><b>GetTransition</b> (const std::string &transition)</td></tr>
|
|
<tr class="separator:a5d8d8907bf7b38d94ed80731547a7001"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3909b01b368700fdac1fa72458523c71"><td class="memItemLeft" align="right" valign="top"><a id="a3909b01b368700fdac1fa72458523c71"></a>
|
|
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &os, const State &state)</td></tr>
|
|
<tr class="separator:a3909b01b368700fdac1fa72458523c71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0b4ce435b849ffb997fd4d65d9434cb"><td class="memItemLeft" align="right" valign="top"><a id="ac0b4ce435b849ffb997fd4d65d9434cb"></a>
|
|
std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &os, const Transition &transition)</td></tr>
|
|
<tr class="separator:ac0b4ce435b849ffb997fd4d65d9434cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1486a99015b84751cfcd1cac55bb351e"><td class="memItemLeft" align="right" valign="top"><a id="a1486a99015b84751cfcd1cac55bb351e"></a>
|
|
Properties </td><td class="memItemRight" valign="bottom"><b>SuboptParser</b> (const vector< string > &channelConfig, const string &deviceId)</td></tr>
|
|
<tr class="separator:a1486a99015b84751cfcd1cac55bb351e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d21f3651cb922015015a9768eb46e9f"><td class="memItemLeft" align="right" valign="top">Properties </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefair_1_1mq.html#a9d21f3651cb922015015a9768eb46e9f">SuboptParser</a> (const std::vector< std::string > &channelConfig, const std::string &deviceId)</td></tr>
|
|
<tr class="separator:a9d21f3651cb922015015a9768eb46e9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39b69191e1efac615545202263f4f67c"><td class="memItemLeft" align="right" valign="top"><a id="a39b69191e1efac615545202263f4f67c"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>TransportName</b> (Transport transport)</td></tr>
|
|
<tr class="separator:a39b69191e1efac615545202263f4f67c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50d4fc4241b119775146f28ef912f6e8"><td class="memItemLeft" align="right" valign="top"><a id="a50d4fc4241b119775146f28ef912f6e8"></a>
|
|
Transport </td><td class="memItemRight" valign="bottom"><b>TransportType</b> (const std::string &transport)</td></tr>
|
|
<tr class="separator:a50d4fc4241b119775146f28ef912f6e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a7b162ae9c34f36f48e2a372ccaec8737"><td class="memItemLeft" align="right" valign="top"><a id="a7b162ae9c34f36f48e2a372ccaec8737"></a>
|
|
const <a class="el" href="structfair_1_1mq_1_1ErrorCategory.html">ErrorCategory</a> </td><td class="memItemRight" valign="bottom"><b>errorCategory</b> {}</td></tr>
|
|
<tr class="separator:a7b162ae9c34f36f48e2a372ccaec8737"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a70b81cfd160d2851f2ea8769513d0e"><td class="memItemLeft" align="right" valign="top">array< string, 16 > </td><td class="memItemRight" valign="bottom"><b>stateNames</b></td></tr>
|
|
<tr class="separator:a8a70b81cfd160d2851f2ea8769513d0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceb0e61c7665ab1af8759877e2c4e4ad"><td class="memItemLeft" align="right" valign="top">unordered_map< string, State > </td><td class="memItemRight" valign="bottom"><b>states</b></td></tr>
|
|
<tr class="separator:aceb0e61c7665ab1af8759877e2c4e4ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca7bfeabd355f26873b78463afb3cbcd"><td class="memItemLeft" align="right" valign="top">array< string, 12 > </td><td class="memItemRight" valign="bottom"><b>transitionNames</b></td></tr>
|
|
<tr class="separator:aca7bfeabd355f26873b78463afb3cbcd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae37367ec70329f6e31938ce22d1ada9e"><td class="memItemLeft" align="right" valign="top">unordered_map< string, Transition > </td><td class="memItemRight" valign="bottom"><b>transitions</b></td></tr>
|
|
<tr class="separator:ae37367ec70329f6e31938ce22d1ada9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Tools for interfacing containers to the transport via polymorphic allocators. </p>
|
|
<dl class="section author"><dt>Author</dt><dd>Mikolaj Krzewicki, <a href="#" onclick="location.href='mai'+'lto:'+'mkr'+'ze'+'wic'+'@c'+'ern'+'.c'+'h'; return false;">mkrze<span style="display: none;">.nosp@m.</span>wic@<span style="display: none;">.nosp@m.</span>cern.<span style="display: none;">.nosp@m.</span>ch</a> </dd></dl>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a9d21f3651cb922015015a9768eb46e9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d21f3651cb922015015a9768eb46e9f">◆ </a></span>SuboptParser()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Properties fair::mq::SuboptParser </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< std::string > & </td>
|
|
<td class="paramname"><em>channelConfig</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>deviceId</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>A parser implementation for FairMQ channel properties. The parser handles a comma separated key=value list format by using the getsubopt function of the standard library.</p>
|
|
<p>The option key '–channel-config' can be used with the list of key/value pairs like e.g. </p><pre>
|
|
--channel-config name=output,type=push,method=bind
|
|
</pre><p>The FairMQ option parser defines a 'UserParser' function for different formats. Currently it is strictly parsing channel options, but in general the concept is extensible by renaming UserParser to ChannelPropertyParser and introducing additional parser functions. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a8a70b81cfd160d2851f2ea8769513d0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a70b81cfd160d2851f2ea8769513d0e">◆ </a></span>stateNames</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">array<string, 16> fair::mq::stateNames</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="stringliteral">"UNDEFINED"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"OK"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"ERROR"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"IDLE"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"INITIALIZING DEVICE"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"INITIALIZED"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"BINDING"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"BOUND"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"CONNECTING"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"DEVICE READY"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"INITIALIZING TASK"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"READY"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"RUNNING"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"RESETTING TASK"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"RESETTING DEVICE"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"EXITING"</span></div>
|
|
<div class="line"> }</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aceb0e61c7665ab1af8759877e2c4e4ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aceb0e61c7665ab1af8759877e2c4e4ad">◆ </a></span>states</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unordered_map<string, State> fair::mq::states</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> { <span class="stringliteral">"UNDEFINED"</span>, State::Undefined },</div>
|
|
<div class="line"> { <span class="stringliteral">"OK"</span>, State::Ok },</div>
|
|
<div class="line"> { <span class="stringliteral">"ERROR"</span>, State::Error },</div>
|
|
<div class="line"> { <span class="stringliteral">"IDLE"</span>, State::Idle },</div>
|
|
<div class="line"> { <span class="stringliteral">"INITIALIZING DEVICE"</span>, State::InitializingDevice },</div>
|
|
<div class="line"> { <span class="stringliteral">"INITIALIZED"</span>, State::Initialized },</div>
|
|
<div class="line"> { <span class="stringliteral">"BINDING"</span>, State::Binding },</div>
|
|
<div class="line"> { <span class="stringliteral">"BOUND"</span>, State::Bound },</div>
|
|
<div class="line"> { <span class="stringliteral">"CONNECTING"</span>, State::Connecting },</div>
|
|
<div class="line"> { <span class="stringliteral">"DEVICE READY"</span>, State::DeviceReady },</div>
|
|
<div class="line"> { <span class="stringliteral">"INITIALIZING TASK"</span>, State::InitializingTask },</div>
|
|
<div class="line"> { <span class="stringliteral">"READY"</span>, State::Ready },</div>
|
|
<div class="line"> { <span class="stringliteral">"RUNNING"</span>, State::Running },</div>
|
|
<div class="line"> { <span class="stringliteral">"RESETTING TASK"</span>, State::ResettingTask },</div>
|
|
<div class="line"> { <span class="stringliteral">"RESETTING DEVICE"</span>, State::ResettingDevice },</div>
|
|
<div class="line"> { <span class="stringliteral">"EXITING"</span>, State::Exiting }</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aca7bfeabd355f26873b78463afb3cbcd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca7bfeabd355f26873b78463afb3cbcd">◆ </a></span>transitionNames</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">array<string, 12> fair::mq::transitionNames</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> <span class="stringliteral">"AUTO"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"INIT DEVICE"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"COMPLETE INIT"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"BIND"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"CONNECT"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"INIT TASK"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"RUN"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"STOP"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"RESET TASK"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"RESET DEVICE"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"END"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"ERROR FOUND"</span></div>
|
|
<div class="line"> }</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ae37367ec70329f6e31938ce22d1ada9e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae37367ec70329f6e31938ce22d1ada9e">◆ </a></span>transitions</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unordered_map<string, Transition> fair::mq::transitions</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> { <span class="stringliteral">"AUTO"</span>, Transition::Auto },</div>
|
|
<div class="line"> { <span class="stringliteral">"INIT DEVICE"</span>, Transition::InitDevice },</div>
|
|
<div class="line"> { <span class="stringliteral">"COMPLETE INIT"</span>, Transition::CompleteInit },</div>
|
|
<div class="line"> { <span class="stringliteral">"BIND"</span>, Transition::Bind },</div>
|
|
<div class="line"> { <span class="stringliteral">"CONNECT"</span>, Transition::Connect },</div>
|
|
<div class="line"> { <span class="stringliteral">"INIT TASK"</span>, Transition::InitTask },</div>
|
|
<div class="line"> { <span class="stringliteral">"RUN"</span>, Transition::Run },</div>
|
|
<div class="line"> { <span class="stringliteral">"STOP"</span>, Transition::Stop },</div>
|
|
<div class="line"> { <span class="stringliteral">"RESET TASK"</span>, Transition::ResetTask },</div>
|
|
<div class="line"> { <span class="stringliteral">"RESET DEVICE"</span>, Transition::ResetDevice },</div>
|
|
<div class="line"> { <span class="stringliteral">"END"</span>, Transition::End },</div>
|
|
<div class="line"> { <span class="stringliteral">"ERROR FOUND"</span>, Transition::ErrorFound }</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|