<!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.h Source File</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 -->
<h1>gr_dispatcher.h</h1><a href="gr__dispatcher_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2005 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_DISPATCHER_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_DISPATCHER_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__select__handler_8h.html">gr_select_handler.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <vector></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classgr__dispatcher.html" title="invoke callbacks based on select.">gr_dispatcher</a>;
<a name="l00030"></a>00030 <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>;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <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#afc128638a4210cda3f88a71f0689c152">gr_dispatcher_singleton</a>();
<a name="l00033"></a>00033 <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#ac8511066b40fcc271708b381c68e75f0">gr_make_dispatcher</a>();
<a name="l00034"></a>00034 <span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment">/*!</span>
<a name="l00036"></a>00036 <span class="comment"> * \brief invoke callbacks based on select.</span>
<a name="l00037"></a>00037 <span class="comment"> * \ingroup internal</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * \sa gr_select_handler</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a><a class="code" href="classgr__dispatcher.html">00041</a> <span class="keyword">class </span><a class="code" href="classgr__dispatcher.html" title="invoke callbacks based on select.">gr_dispatcher</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <a class="code" href="classgr__dispatcher.html" title="invoke callbacks based on select.">gr_dispatcher</a>();
<a name="l00044"></a>00044 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_dispatcher_sptr</a> <a class="code" href="classgr__dispatcher.html#ac8511066b40fcc271708b381c68e75f0">gr_make_dispatcher</a>();
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <a class="code" href="classstd_1_1vector.html">std::vector<gr_select_handler_sptr></a> d_handler;
<a name="l00047"></a>00047 <span class="keywordtype">int</span> d_max_index;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <a class="code" href="classgr__dispatcher.html#ac4efcfd65279f042a891df1e51fc2dec">~gr_dispatcher</a>();
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keywordtype">bool</span> <a class="code" href="classgr__dispatcher.html#a761602cfdc4515148d2b2e911e87a33d">add_handler</a>(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_select_handler_sptr</a> handler);
<a name="l00053"></a>00053 <span class="keywordtype">bool</span> <a class="code" href="classgr__dispatcher.html#af5e406f189d728e550d53f11027efe95">del_handler</a>(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_select_handler_sptr</a> handler);
<a name="l00054"></a>00054 <span class="keywordtype">bool</span> <a class="code" href="classgr__dispatcher.html#af5e406f189d728e550d53f11027efe95">del_handler</a>(<a class="code" href="classgr__select__handler.html" title="Abstract handler for select based notification.">gr_select_handler</a> *handler);
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /*!</span>
<a name="l00057"></a>00057 <span class="comment"> * \brief Event dispatching loop.</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * Enter a polling loop that only terminates after all gr_select_handlers</span>
<a name="l00060"></a>00060 <span class="comment"> * have been removed. \p timeout sets the timeout parameter to the select()</span>
<a name="l00061"></a>00061 <span class="comment"> * call, measured in seconds.</span>
<a name="l00062"></a>00062 <span class="comment"> *</span>
<a name="l00063"></a>00063 <span class="comment"> * \param timeout maximum number of seconds to block in select.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <span class="keywordtype">void</span> <a class="code" href="classgr__dispatcher.html#a04d629d6169a9e8a2005863e70eae083" title="Event dispatching loop.">loop</a>(<span class="keywordtype">double</span> timeout=10);
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_DISPATCHER_H */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:50:59 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>
