<!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.h Source File</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('gr__dispatcher_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">gr_dispatcher.h</div> </div> </div><!--header--> <div class="contents"> <a href="gr__dispatcher_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2005 Free Software Foundation, Inc.</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDED_GR_DISPATCHER_H</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_DISPATCHER_H</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr__core__api_8h.html">gr_core_api.h</a>></span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="gr__select__handler_8h.html">gr_select_handler.h</a>></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <vector></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="classgr__dispatcher.html" title="invoke callbacks based on select.">gr_dispatcher</a>;</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_dispatcher></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_dispatcher_sptr</a>;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_dispatcher_sptr</a> <a class="code" href="gr__dispatcher_8h.html#a388a8a1097577fa96df011634f9b4fa0">gr_dispatcher_singleton</a>();</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_dispatcher_sptr</a> <a class="code" href="gr__dispatcher_8h.html#adc59ca2913cbff8f258843e2c411a690">gr_make_dispatcher</a>();</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/*!</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * \brief invoke callbacks based on select.</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * \ingroup internal</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * \sa gr_select_handler</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div> <div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="classgr__dispatcher.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classgr__dispatcher.html" title="invoke callbacks based on select.">gr_dispatcher</a></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classgr__dispatcher.html" title="invoke callbacks based on select.">gr_dispatcher</a>();</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">friend</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_dispatcher_sptr</a> <a class="code" href="gr__dispatcher_8h.html#adc59ca2913cbff8f258843e2c411a690">gr_make_dispatcher</a>();</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::vector<gr_select_handler_sptr> d_handler;</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">int</span> d_max_index;</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ~gr_dispatcher();</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span> add_handler(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_select_handler_sptr</a> handler);</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">bool</span> del_handler(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_select_handler_sptr</a> handler);</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">bool</span> del_handler(<a class="code" href="classgr__select__handler.html" title="Abstract handler for select based notification.">gr_select_handler</a> *handler);</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /*!</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * \brief Event dispatching loop.</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * Enter a polling loop that only terminates after all gr_select_handlers</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * have been removed. \p timeout sets the timeout parameter to the select()</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * call, measured in seconds.</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * \param timeout maximum number of seconds to block in select.</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> loop(<span class="keywordtype">double</span> timeout=10);</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> };</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_DISPATCHER_H */</span><span class="preprocessor"></span></div> </div><!-- fragment --></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="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_9fb53df2329c53c13edd0243de4d83d5.html">runtime</a></li><li class="navelem"><a class="el" href="gr__dispatcher_8h.html">gr_dispatcher.h</a></li> <li class="footer">Generated on Fri Apr 19 2013 16:20:33 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>