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 #include <omnithread.h>
  26
  27 /*!
  28  * \brief Public constructor (factory) for mb_runtime objects.
  29  */
  30 mb_runtime_sptr mb_make_runtime();
  31
  32 /*!
  33  * \brief Abstract runtime support for m-blocks
  34  *
  35  * There should generally be only a single instance of this class.
  36  */
  37 class mb_runtime : boost::noncopyable,
  38                    public boost::enable_shared_from_this<mb_runtime>
  39 {
  40   omni_mutex    d_brl;          // big runtime lock (avoid using this if possible...)
  41
  42 public:
  43   mb_runtime(){}
  44   virtual ~mb_runtime();
  45
  46   /*!
  47    * \brief Run the mblock hierarchy rooted at \p top
  48    *
  49    * This routine turns into the m-block scheduler, and
  50    * blocks until the system is shutdown.
  51    *
  52    * \param top top-level mblock
  53    * \returns true if the system ran successfully.
  54    */
  55   virtual bool run(mb_mblock_sptr top) = 0;
  56
  57
  58   // ----------------------------------------------------------------
  59   // Stuff from here down is really private to the implementation...
  60   // ----------------------------------------------------------------
  61
  62   /*!
  63    * \brief lock the big runtime lock
  64    * \implementation
  65    */
  66   inline void lock() { d_brl.lock(); }
  67
  68   /*!
  69    * \brief unlock the big runtime lock
  70    * \implementation
  71    */
  72   inline void unlock() { d_brl.unlock(); }
  73
  74 };
  75
  76 #endif /* INCLUDED_MB_RUNTIME_H */