<!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"/> <title>GNU Radio 3.3.0 C++ API: gr_dispatcher Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="contents"> <h1>gr_dispatcher Class Reference<br/> <small> [<a class="el" href="group__internal.html">Implementation Details</a>]</small> </h1><!-- doxytag: class="gr_dispatcher" --> <p>invoke callbacks based on select. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__dispatcher_8h_source.html">gr_dispatcher.h</a>></code></p> <p><a href="classgr__dispatcher-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><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><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </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><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </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><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </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><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__dispatcher.html#a04d629d6169a9e8a2005863e70eae083">loop</a> (double timeout=10)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Event dispatching loop. <a href="#a04d629d6169a9e8a2005863e70eae083"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><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#ac8511066b40fcc271708b381c68e75f0">gr_make_dispatcher</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>invoke callbacks based on select. </p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgr__select__handler.html" title="Abstract handler for select based notification.">gr_select_handler</a> </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac4efcfd65279f042a891df1e51fc2dec"></a><!-- doxytag: member="gr_dispatcher::~gr_dispatcher" ref="ac4efcfd65279f042a891df1e51fc2dec" args="()" --> <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> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a761602cfdc4515148d2b2e911e87a33d"></a><!-- doxytag: member="gr_dispatcher::add_handler" ref="a761602cfdc4515148d2b2e911e87a33d" args="(gr_select_handler_sptr handler)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> 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="a65344f6ad7fdf57ca74729b97a278e48"></a><!-- doxytag: member="gr_dispatcher::del_handler" ref="a65344f6ad7fdf57ca74729b97a278e48" args="(gr_select_handler *handler)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> 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="af5e406f189d728e550d53f11027efe95"></a><!-- doxytag: member="gr_dispatcher::del_handler" ref="af5e406f189d728e550d53f11027efe95" args="(gr_select_handler_sptr handler)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> 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="a04d629d6169a9e8a2005863e70eae083"></a><!-- doxytag: member="gr_dispatcher::loop" ref="a04d629d6169a9e8a2005863e70eae083" args="(double timeout=10)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void 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><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>maximum number of seconds to block in select. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ac8511066b40fcc271708b381c68e75f0"></a><!-- doxytag: member="gr_dispatcher::gr_make_dispatcher" ref="ac8511066b40fcc271708b381c68e75f0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><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><code> [friend]</code></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> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:41 2010 for GNU Radio 3.3.0 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>