git.gag.com Git - debian/gnuradio/blob - mblock/src/lib/mb_runtime.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006 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 along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21 #ifndef INCLUDED_MB_RUNTIME_H
  22 #define INCLUDED_MB_RUNTIME_H
  23
  24 #include <mb_common.h>
  25
  26 /*!
  27  * \brief Public constructor for mb_runtime.
  28  */
  29 mb_runtime_sptr mb_make_runtime();
  30
  31 /*!
  32  * \brief Runtime support for m-blocks
  33  *
  34  * There should generally be only a single instance of this class.
  35  *
  36  * It should be created by the top-level initialization code,
  37  * and that instance should be passed into the constructor of the
  38  * top-level mblock.
  39  */
  40 class mb_runtime : boost::noncopyable
  41 {
  42 private:
  43   mb_runtime_impl_sptr          d_impl;           // implementation details
  44
  45   mb_runtime();
  46
  47   friend mb_runtime_sptr mb_make_runtime();
  48
  49 public:
  50   ~mb_runtime();
  51
  52   /*!
  53    * \brief Run the mblocks...
  54    *
  55    * This routine turns into the m-block scheduler, and
  56    * blocks until the system is shutdown.
  57    *
  58    * \returns true if the system ran successfully.
  59    */
  60   bool run();
  61 };
  62
  63 #endif /* INCLUDED_MB_RUNTIME_H */