Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 00:31:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.4.33/classfair_1_1mq_1_1StateMachine.html
Alexey Rybalchenko 6d82d305b9 Add API docs for v1.4.33
2021-03-23 14:11:44 +01:00

138 lines
9.7 KiB
HTML
Raw Permalink Blame History

<!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::StateMachine Class 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
&#160;<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&amp;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&amp;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><li class="navelem"><a class="el" href="classfair_1_1mq_1_1StateMachine.html">StateMachine</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classfair_1_1mq_1_1StateMachine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::StateMachine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1StateMachine_1_1ErrorStateException.html">ErrorStateException</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a06e18e6b4c305445aa538be100f2d3d6"><td class="memItemLeft" align="right" valign="top"><a id="a06e18e6b4c305445aa538be100f2d3d6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ChangeState</b> (const Transition transition)</td></tr>
<tr class="separator:a06e18e6b4c305445aa538be100f2d3d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a960008b1f964711676ff6a574df54dfc"><td class="memItemLeft" align="right" valign="top"><a id="a960008b1f964711676ff6a574df54dfc"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ChangeState</b> (const std::string &amp;transition)</td></tr>
<tr class="separator:a960008b1f964711676ff6a574df54dfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2230cebc43a52ca3e829ae109313c997"><td class="memItemLeft" align="right" valign="top"><a id="a2230cebc43a52ca3e829ae109313c997"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SubscribeToStateChange</b> (const std::string &amp;key, std::function&lt; void(const State)&gt; callback)</td></tr>
<tr class="separator:a2230cebc43a52ca3e829ae109313c997"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40af1deebd7025fb67e84b553abacaa2"><td class="memItemLeft" align="right" valign="top"><a id="a40af1deebd7025fb67e84b553abacaa2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>UnsubscribeFromStateChange</b> (const std::string &amp;key)</td></tr>
<tr class="separator:a40af1deebd7025fb67e84b553abacaa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a894c1fa836641f9ecd4b0eed0880061c"><td class="memItemLeft" align="right" valign="top"><a id="a894c1fa836641f9ecd4b0eed0880061c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>HandleStates</b> (std::function&lt; void(const State)&gt; callback)</td></tr>
<tr class="separator:a894c1fa836641f9ecd4b0eed0880061c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a105e32e827b8302ea6986a1f5917f4fb"><td class="memItemLeft" align="right" valign="top"><a id="a105e32e827b8302ea6986a1f5917f4fb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>StopHandlingStates</b> ()</td></tr>
<tr class="separator:a105e32e827b8302ea6986a1f5917f4fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bf3d074a3427f0a0da92bf12eabb668"><td class="memItemLeft" align="right" valign="top"><a id="a1bf3d074a3427f0a0da92bf12eabb668"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SubscribeToNewTransition</b> (const std::string &amp;key, std::function&lt; void(const Transition)&gt; callback)</td></tr>
<tr class="separator:a1bf3d074a3427f0a0da92bf12eabb668"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73efeea42d2f3a73bf68cb942c8a69ce"><td class="memItemLeft" align="right" valign="top"><a id="a73efeea42d2f3a73bf68cb942c8a69ce"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>UnsubscribeFromNewTransition</b> (const std::string &amp;key)</td></tr>
<tr class="separator:a73efeea42d2f3a73bf68cb942c8a69ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fdc568aaae3f2c855725c385053d7a1"><td class="memItemLeft" align="right" valign="top"><a id="a2fdc568aaae3f2c855725c385053d7a1"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>NewStatePending</b> () const</td></tr>
<tr class="separator:a2fdc568aaae3f2c855725c385053d7a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5288d7553bdf5ebdd7519c85d9b548b7"><td class="memItemLeft" align="right" valign="top"><a id="a5288d7553bdf5ebdd7519c85d9b548b7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>WaitForPendingState</b> () const</td></tr>
<tr class="separator:a5288d7553bdf5ebdd7519c85d9b548b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f3a202e3712ef561a66098dd3282553"><td class="memItemLeft" align="right" valign="top"><a id="a2f3a202e3712ef561a66098dd3282553"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>WaitForPendingStateFor</b> (const int durationInMs) const</td></tr>
<tr class="separator:a2f3a202e3712ef561a66098dd3282553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52e04429d633b50b4f3f63235fa6a87a"><td class="memItemLeft" align="right" valign="top"><a id="a52e04429d633b50b4f3f63235fa6a87a"></a>
State&#160;</td><td class="memItemRight" valign="bottom"><b>GetCurrentState</b> () const</td></tr>
<tr class="separator:a52e04429d633b50b4f3f63235fa6a87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1162ac5f563263ef5ba107a7f17f6f9f"><td class="memItemLeft" align="right" valign="top"><a id="a1162ac5f563263ef5ba107a7f17f6f9f"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetCurrentStateName</b> () const</td></tr>
<tr class="separator:a1162ac5f563263ef5ba107a7f17f6f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94c93f8203bab4f5a3784eba7445b582"><td class="memItemLeft" align="right" valign="top"><a id="a94c93f8203bab4f5a3784eba7445b582"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Start</b> ()</td></tr>
<tr class="separator:a94c93f8203bab4f5a3784eba7445b582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2ce283104c5d624ad5f740e017cf2a4"><td class="memItemLeft" align="right" valign="top"><a id="ab2ce283104c5d624ad5f740e017cf2a4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>ProcessWork</b> ()</td></tr>
<tr class="separator:ab2ce283104c5d624ad5f740e017cf2a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/<a class="el" href="StateMachine_8h_source.html">StateMachine.h</a></li>
<li>fairmq/StateMachine.cxx</li>
</ul>
</div><!-- contents -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
Reference in New Issue View Git Blame Copy Permalink