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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2007 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_MSG_QUEUE_H
  22 #define INCLUDED_MB_MSG_QUEUE_H
  23
  24 #include <mb_common.h>
  25 //#include <omnithread.h>       FIXME
  26
  27 /*!
  28  * \brief priority queue for mblock messages
  29  */
  30 class mb_msg_queue : boost::noncopyable
  31 {
  32   // When empty both head and tail are zero.
  33   struct subq {
  34     mb_message_sptr     head;
  35     mb_message_sptr     tail;
  36
  37     bool empty_p() const { return head == 0; }
  38   };
  39
  40   // omni_mutex d_mutex;        FIXME
  41
  42   // FIXME add bitmap to indicate which queues are non-empty.
  43   subq          d_queue[MB_NPRI];
  44
  45 public:
  46   mb_msg_queue();
  47   ~mb_msg_queue();
  48
  49   //! Insert \p msg into priority queue.
  50   void insert(mb_message_sptr msg);
  51
  52   /*
  53    * \brief Delete highest pri message from the queue and return it.
  54    * Returns equivalent of zero pointer if queue is empty.
  55    */
  56   mb_message_sptr get_highest_pri_msg();
  57 };
  58
  59 #endif /* INCLUDED_MB_MSG_QUEUE_H */