<!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.2.2 C++ API: gr_select_handler.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.2 --> <h1>gr_select_handler.h</h1><a href="gr__select__handler_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_SELECT_HANDLER_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_SELECT_HANDLER_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <boost/shared_ptr.hpp></span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classgr__select__handler.html" title="Abstract handler for select based notification.">gr_select_handler</a>; <a name="l00029"></a>00029 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_select_handler></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_select_handler_sptr</a>; <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="comment"></span> <a name="l00032"></a>00032 <span class="comment">/*!</span> <a name="l00033"></a>00033 <span class="comment"> * \brief Abstract handler for select based notification.</span> <a name="l00034"></a>00034 <span class="comment"> * \ingroup base</span> <a name="l00035"></a>00035 <span class="comment"> *</span> <a name="l00036"></a>00036 <span class="comment"> * \sa gr_dispatcher</span> <a name="l00037"></a>00037 <span class="comment"> */</span> <a name="l00038"></a><a class="code" href="classgr__select__handler.html">00038</a> <span class="keyword">class </span><a class="code" href="classgr__select__handler.html" title="Abstract handler for select based notification.">gr_select_handler</a> <a name="l00039"></a>00039 { <a name="l00040"></a>00040 <span class="keywordtype">int</span> d_fd; <a name="l00041"></a>00041 <a name="l00042"></a>00042 <span class="keyword">protected</span>: <a name="l00043"></a>00043 <a class="code" href="classgr__select__handler.html#acd6f81769629190cdbfbe15e2dbedc75">gr_select_handler</a>(<span class="keywordtype">int</span> <a class="code" href="classgr__select__handler.html#a956166f072ade292b3f074a2817b7583">file_descriptor</a>); <a name="l00044"></a>00044 <a name="l00045"></a>00045 <span class="keyword">public</span>: <a name="l00046"></a>00046 <span class="keyword">virtual</span> <a class="code" href="classgr__select__handler.html#a9b80622ea03a3e6bf0fea745645b210c">~gr_select_handler</a>(); <a name="l00047"></a>00047 <a name="l00048"></a><a class="code" href="classgr__select__handler.html#a1855395f405a0ffd429ccd5aac7f98e8">00048</a> <span class="keywordtype">int</span> <a class="code" href="classgr__select__handler.html#a1855395f405a0ffd429ccd5aac7f98e8">fd</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_fd; } <a name="l00049"></a><a class="code" href="classgr__select__handler.html#a956166f072ade292b3f074a2817b7583">00049</a> <span class="keywordtype">int</span> <a class="code" href="classgr__select__handler.html#a956166f072ade292b3f074a2817b7583">file_descriptor</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_fd; } <a name="l00050"></a>00050 <span class="comment"></span> <a name="l00051"></a>00051 <span class="comment"> /*!</span> <a name="l00052"></a>00052 <span class="comment"> * \brief Called when file_descriptor is readable.</span> <a name="l00053"></a>00053 <span class="comment"> *</span> <a name="l00054"></a>00054 <span class="comment"> * Called when the dispatcher detects that file_descriptor can</span> <a name="l00055"></a>00055 <span class="comment"> * be read without blocking.</span> <a name="l00056"></a>00056 <span class="comment"> */</span> <a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__select__handler.html#a724b67b0348d179a73c470ae7af362fe" title="Called when file_descriptor is readable.">handle_read</a>() = 0; <a name="l00058"></a>00058 <span class="comment"></span> <a name="l00059"></a>00059 <span class="comment"> /*!</span> <a name="l00060"></a>00060 <span class="comment"> * \brief Called when file_descriptor is writable.</span> <a name="l00061"></a>00061 <span class="comment"> *</span> <a name="l00062"></a>00062 <span class="comment"> * Called when dispatcher detects that file descriptor can be </span> <a name="l00063"></a>00063 <span class="comment"> * written without blocking.</span> <a name="l00064"></a>00064 <span class="comment"> */</span> <a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__select__handler.html#a63f2969f8e586f52b89c67ecfbe33173" title="Called when file_descriptor is writable.">handle_write</a>() = 0; <a name="l00066"></a>00066 <span class="comment"></span> <a name="l00067"></a>00067 <span class="comment"> /*!</span> <a name="l00068"></a>00068 <span class="comment"> * Called each time around the dispatcher loop to determine whether</span> <a name="l00069"></a>00069 <span class="comment"> * this handler's file descriptor should be added to the list on which</span> <a name="l00070"></a>00070 <span class="comment"> * read events can occur. The default method returns true, indicating</span> <a name="l00071"></a>00071 <span class="comment"> * that by default, all handlers are interested in read events.</span> <a name="l00072"></a>00072 <span class="comment"> */</span> <a name="l00073"></a><a class="code" href="classgr__select__handler.html#aa7ee5d26f4e0ebf6966eadf8f180cd86">00073</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgr__select__handler.html#aa7ee5d26f4e0ebf6966eadf8f180cd86">readable</a>() { <span class="keywordflow">return</span> <span class="keyword">true</span>; } <a name="l00074"></a>00074 <span class="comment"></span> <a name="l00075"></a>00075 <span class="comment"> /*!</span> <a name="l00076"></a>00076 <span class="comment"> * Called each time around the dispatcher loop to determine whether</span> <a name="l00077"></a>00077 <span class="comment"> * this handler's file descriptor should be added to the list on which</span> <a name="l00078"></a>00078 <span class="comment"> * write events can occur. The default method returns true, indicating</span> <a name="l00079"></a>00079 <span class="comment"> * that by default, all handlers are interested in write events.</span> <a name="l00080"></a>00080 <span class="comment"> */</span> <a name="l00081"></a><a class="code" href="classgr__select__handler.html#a3d0294e3233c547a06b13ba107643045">00081</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgr__select__handler.html#a3d0294e3233c547a06b13ba107643045">writable</a>() { <span class="keywordflow">return</span> <span class="keyword">true</span>; } <a name="l00082"></a>00082 }; <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_SELECT_HANDLER_H */</span> </pre></div></div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>