gr_msg_queue.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2005 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio
 * 
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 * 
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
#ifndef INCLUDED_GR_MSG_QUEUE_H
#define INCLUDED_GR_MSG_QUEUE_H

#include <gr_msg_handler.h>
#include <omnithread.h>

class gr_msg_queue;
typedef boost::shared_ptr<gr_msg_queue> gr_msg_queue_sptr;

gr_msg_queue_sptr gr_make_msg_queue(unsigned int limit=0);

class gr_msg_queue : public gr_msg_handler {
  omni_mutex            d_mutex;
  omni_condition        d_not_empty;
  omni_condition        d_not_full;
  gr_message_sptr       d_head;
  gr_message_sptr       d_tail;
  unsigned int          d_count;    // # of messages in queue.
  unsigned int          d_limit;    // max # of messages in queue.  0 -> unbounded

public:
  gr_msg_queue(unsigned int limit);
  ~gr_msg_queue();

  void handle(gr_message_sptr msg) { insert_tail (msg); }

  void insert_tail(gr_message_sptr msg);

  gr_message_sptr delete_head();

  gr_message_sptr delete_head_nowait();
  
  void flush();

  bool empty_p() const { return d_count == 0; }
  
  bool full_p() const { return d_limit != 0 && d_count >= d_limit; }
  
  unsigned int count() const { return d_count; }

  unsigned int limit() const { return d_limit; }

};

#endif /* INCLUDED_GR_MSG_QUEUE_H */

---