git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/runtime/gr_dispatcher.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_GR_DISPATCHER_H
  24 #define INCLUDED_GR_DISPATCHER_H
  25
  26 #include <gr_select_handler.h>
  27 #include <vector>
  28
  29 class gr_dispatcher;
  30 typedef boost::shared_ptr<gr_dispatcher> gr_dispatcher_sptr;
  31
  32 gr_dispatcher_sptr gr_dispatcher_singleton();
  33 gr_dispatcher_sptr gr_make_dispatcher();
  34
  35 /*!
  36  * \brief invoke callbacks based on select.
  37  *
  38  * \sa gr_select_handler
  39  */
  40 class gr_dispatcher
  41 {
  42   gr_dispatcher();
  43   friend gr_dispatcher_sptr gr_make_dispatcher();
  44
  45   std::vector<gr_select_handler_sptr> d_handler;
  46   int                                 d_max_index;
  47
  48 public:
  49   ~gr_dispatcher();
  50
  51   bool add_handler(gr_select_handler_sptr handler);
  52   bool del_handler(gr_select_handler_sptr handler);
  53   bool del_handler(gr_select_handler *handler);
  54
  55   /*!
  56    * \brief Event dispatching loop.
  57    *
  58    * Enter a polling loop that only terminates after all gr_select_handlers
  59    * have been removed.  \p timeout sets the timeout parameter to the select()
  60    * call, measured in seconds.
  61    *
  62    * \param timeout maximum number of seconds to block in select.
  63    */
  64   void loop(double timeout=10);
  65 };
  66
  67 #endif /* INCLUDED_GR_DISPATCHER_H */