GNU Radio 3.4.0 C++ API
|
00001 /* -*- c++ -*- */ 00002 /* 00003 * Copyright 2005 Free Software Foundation, Inc. 00004 * 00005 * This file is part of GNU Radio 00006 * 00007 * GNU Radio is free software; you can redistribute it and/or modify 00008 * it under the terms of the GNU General Public License as published by 00009 * the Free Software Foundation; either version 3, or (at your option) 00010 * any later version. 00011 * 00012 * GNU Radio is distributed in the hope that it will be useful, 00013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00015 * GNU General Public License for more details. 00016 * 00017 * You should have received a copy of the GNU General Public License 00018 * along with GNU Radio; see the file COPYING. If not, write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, 00020 * Boston, MA 02110-1301, USA. 00021 */ 00022 00023 #ifndef INCLUDED_GR_SELECT_HANDLER_H 00024 #define INCLUDED_GR_SELECT_HANDLER_H 00025 00026 #include <boost/shared_ptr.hpp> 00027 00028 class gr_select_handler; 00029 typedef boost::shared_ptr<gr_select_handler> gr_select_handler_sptr; 00030 00031 00032 /*! 00033 * \brief Abstract handler for select based notification. 00034 * \ingroup base 00035 * 00036 * \sa gr_dispatcher 00037 */ 00038 class gr_select_handler 00039 { 00040 int d_fd; 00041 00042 protected: 00043 gr_select_handler(int file_descriptor); 00044 00045 public: 00046 virtual ~gr_select_handler(); 00047 00048 int fd() const { return d_fd; } 00049 int file_descriptor() const { return d_fd; } 00050 00051 /*! 00052 * \brief Called when file_descriptor is readable. 00053 * 00054 * Called when the dispatcher detects that file_descriptor can 00055 * be read without blocking. 00056 */ 00057 virtual void handle_read() = 0; 00058 00059 /*! 00060 * \brief Called when file_descriptor is writable. 00061 * 00062 * Called when dispatcher detects that file descriptor can be 00063 * written without blocking. 00064 */ 00065 virtual void handle_write() = 0; 00066 00067 /*! 00068 * Called each time around the dispatcher loop to determine whether 00069 * this handler's file descriptor should be added to the list on which 00070 * read events can occur. The default method returns true, indicating 00071 * that by default, all handlers are interested in read events. 00072 */ 00073 virtual bool readable() { return true; } 00074 00075 /*! 00076 * Called each time around the dispatcher loop to determine whether 00077 * this handler's file descriptor should be added to the list on which 00078 * write events can occur. The default method returns true, indicating 00079 * that by default, all handlers are interested in write events. 00080 */ 00081 virtual bool writable() { return true; } 00082 }; 00083 00084 #endif /* INCLUDED_GR_SELECT_HANDLER_H */