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