<!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.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_dispatcher 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr__dispatcher.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classgr__dispatcher-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_dispatcher Class Reference<div class="ingroups"><a class="el" href="group__internal.html">Implementation Details</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>invoke callbacks based on select.
<a href="classgr__dispatcher.html#details">More...</a></p>
<p><code>#include <<a class="el" href="gr__dispatcher_8h_source.html">gr_dispatcher.h</a>></code></p>
<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:ac4efcfd65279f042a891df1e51fc2dec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#ac4efcfd65279f042a891df1e51fc2dec">~gr_dispatcher</a> ()</td></tr>
<tr class="separator:ac4efcfd65279f042a891df1e51fc2dec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a761602cfdc4515148d2b2e911e87a33d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#a761602cfdc4515148d2b2e911e87a33d">add_handler</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_select_handler_sptr</a> handler)</td></tr>
<tr class="separator:a761602cfdc4515148d2b2e911e87a33d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5e406f189d728e550d53f11027efe95"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#af5e406f189d728e550d53f11027efe95">del_handler</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_select_handler_sptr</a> handler)</td></tr>
<tr class="separator:af5e406f189d728e550d53f11027efe95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65344f6ad7fdf57ca74729b97a278e48"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#a65344f6ad7fdf57ca74729b97a278e48">del_handler</a> (<a class="el" href="classgr__select__handler.html">gr_select_handler</a> *handler)</td></tr>
<tr class="separator:a65344f6ad7fdf57ca74729b97a278e48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04d629d6169a9e8a2005863e70eae083"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#a04d629d6169a9e8a2005863e70eae083">loop</a> (double timeout=10)</td></tr>
<tr class="memdesc:a04d629d6169a9e8a2005863e70eae083"><td class="mdescLeft"> </td><td class="mdescRight">Event dispatching loop. <a href="#a04d629d6169a9e8a2005863e70eae083"></a><br/></td></tr>
<tr class="separator:a04d629d6169a9e8a2005863e70eae083"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:adc59ca2913cbff8f258843e2c411a690"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_dispatcher_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#adc59ca2913cbff8f258843e2c411a690">gr_make_dispatcher</a> ()</td></tr>
<tr class="separator:adc59ca2913cbff8f258843e2c411a690"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>invoke callbacks based on select. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classgr__select__handler.html" title="Abstract handler for select based notification.">gr_select_handler</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac4efcfd65279f042a891df1e51fc2dec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_dispatcher::~gr_dispatcher </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a761602cfdc4515148d2b2e911e87a33d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gr_dispatcher::add_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_select_handler_sptr</a> </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af5e406f189d728e550d53f11027efe95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gr_dispatcher::del_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_select_handler_sptr</a> </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a65344f6ad7fdf57ca74729b97a278e48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gr_dispatcher::del_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgr__select__handler.html">gr_select_handler</a> * </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a04d629d6169a9e8a2005863e70eae083"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_dispatcher::loop </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>timeout</em> = <code>10</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Event dispatching loop. </p>
<p>Enter a polling loop that only terminates after all gr_select_handlers have been removed. <code>timeout</code> sets the timeout parameter to the select() call, measured in seconds.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>maximum number of seconds to block in select. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="adc59ca2913cbff8f258843e2c411a690"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_dispatcher_sptr</a> gr_make_dispatcher </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__dispatcher_8h_source.html">gr_dispatcher.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classgr__dispatcher.html">gr_dispatcher</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:37 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
