GNU Radio 3.4.0 C++ API
gr_dispatcher.h
Go to the documentation of this file.
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_DISPATCHER_H
00024 #define INCLUDED_GR_DISPATCHER_H
00025 
00026 #include <gr_select_handler.h>
00027 #include <vector>
00028 
00029 class gr_dispatcher;
00030 typedef boost::shared_ptr<gr_dispatcher> gr_dispatcher_sptr;
00031 
00032 gr_dispatcher_sptr gr_dispatcher_singleton();
00033 gr_dispatcher_sptr gr_make_dispatcher();
00034 
00035 /*!
00036  * \brief invoke callbacks based on select.
00037  * \ingroup internal
00038  *
00039  * \sa gr_select_handler
00040  */
00041 class gr_dispatcher
00042 {
00043   gr_dispatcher();
00044   friend gr_dispatcher_sptr gr_make_dispatcher();
00045 
00046   std::vector<gr_select_handler_sptr> d_handler;
00047   int                                 d_max_index;
00048 
00049 public:
00050   ~gr_dispatcher();
00051 
00052   bool add_handler(gr_select_handler_sptr handler);
00053   bool del_handler(gr_select_handler_sptr handler);
00054   bool del_handler(gr_select_handler *handler);
00055 
00056   /*!
00057    * \brief Event dispatching loop.
00058    *
00059    * Enter a polling loop that only terminates after all gr_select_handlers
00060    * have been removed.  \p timeout sets the timeout parameter to the select()
00061    * call, measured in seconds.
00062    *
00063    * \param timeout maximum number of seconds to block in select.
00064    */
00065   void loop(double timeout=10);
00066 };
00067 
00068 #endif /* INCLUDED_GR_DISPATCHER_H */