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

   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 class gr_dispatcher;
  24 typedef boost::shared_ptr<gr_dispatcher> gr_dispatcher_sptr;
  25 %template(gr_dispatcher_sptr) boost::shared_ptr<gr_dispatcher>;
  26
  27 %rename(dispatcher) gr_make_dispatcher;
  28 gr_dispatcher_sptr gr_make_dispatcher();
  29
  30 %rename(dispatcher_singleton) gr_dispatcher_singleton;
  31 gr_dispatcher_sptr gr_dispatcher_singleton();
  32
  33 /*!
  34  * \brief invoke callbacks based on select.
  35  *
  36  * \sa gr_select_handler
  37  */
  38 class gr_dispatcher
  39 {
  40   gr_dispatcher();
  41
  42 public:
  43   ~gr_dispatcher();
  44
  45   /*!
  46    * \brief Event dispatching loop.
  47    *
  48    * Enter a polling loop that only terminates after all gr_select_handlers
  49    * have been removed.  \p timeout sets the timeout parameter to the select()
  50    * call, measured in seconds.
  51    *
  52    * \param timeout maximum number of seconds to block in select.
  53    */
  54   void loop(double timeout=10);
  55 };