FairMQ/v1.3.7/classfair_1_1mq_1_1EventManager.html
2018-11-29 13:31:29 +01:00

114 lines
6.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: fair::mq::EventManager 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.3.7</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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"><a class="el" href="namespacefair.html">fair</a></li><li class="navelem"><b>mq</b></li><li class="navelem"><a class="el" href="classfair_1_1mq_1_1EventManager.html">EventManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classfair_1_1mq_1_1EventManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::EventManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Manages event callbacks from different subscribers.
<a href="classfair_1_1mq_1_1EventManager.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="EventManager_8h_source.html">fairmq/EventManager.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8d5a882eb47ecbd0b762f5c8c0db5336"><td class="memTemplParams" colspan="2"><a id="a8d5a882eb47ecbd0b762f5c8c0db5336"></a>
template&lt;typename E , typename ... Args&gt; </td></tr>
<tr class="memitem:a8d5a882eb47ecbd0b762f5c8c0db5336"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Signal</b> = boost::signals2::signal&lt; void(typename E::KeyType, Args...)&gt;</td></tr>
<tr class="separator:a8d5a882eb47ecbd0b762f5c8c0db5336"><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:aaa9e2193030278b48547ba015740595a"><td class="memTemplParams" colspan="2"><a id="aaa9e2193030278b48547ba015740595a"></a>
template&lt;typename E , typename ... Args&gt; </td></tr>
<tr class="memitem:aaa9e2193030278b48547ba015740595a"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Subscribe</b> (const std::string &amp;subscriber, std::function&lt; void(typename E::KeyType, Args...)&gt; callback) -&gt; void</td></tr>
<tr class="separator:aaa9e2193030278b48547ba015740595a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e723e95b58da314bcb9d8504e0bde38"><td class="memTemplParams" colspan="2"><a id="a4e723e95b58da314bcb9d8504e0bde38"></a>
template&lt;typename E , typename ... Args&gt; </td></tr>
<tr class="memitem:a4e723e95b58da314bcb9d8504e0bde38"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Unsubscribe</b> (const std::string &amp;subscriber) -&gt; void</td></tr>
<tr class="separator:a4e723e95b58da314bcb9d8504e0bde38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14dbe36d51d369484c93944f25f4318f"><td class="memTemplParams" colspan="2"><a id="a14dbe36d51d369484c93944f25f4318f"></a>
template&lt;typename E , typename ... Args&gt; </td></tr>
<tr class="memitem:a14dbe36d51d369484c93944f25f4318f"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Emit</b> (typename E::KeyType key, Args... args) const -&gt; void</td></tr>
<tr class="separator:a14dbe36d51d369484c93944f25f4318f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages event callbacks from different subscribers. </p>
<p>The event manager stores a set of callbacks and associates them with events depending on the callback signature. The first callback argument must be of a special key type determined by the event type.</p>
<p>Callbacks can be subscribed/unsubscribed based on a subscriber id, the event type, and the callback signature.</p>
<p>Events can be emitted based on event type and callback signature.</p>
<p>The event manager is thread-safe. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>fairmq/<a class="el" href="EventManager_8h_source.html">EventManager.h</a></li>
</ul>
</div><!-- contents -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>