3 * Copyright 2005,2009 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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 3, or (at your option)
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.
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
22 #ifndef INCLUDED_GR_MSG_QUEUE_H
23 #define INCLUDED_GR_MSG_QUEUE_H
25 #include <gr_msg_handler.h>
26 #include <gruel/thread.h>
29 typedef boost::shared_ptr<gr_msg_queue> gr_msg_queue_sptr;
31 gr_msg_queue_sptr gr_make_msg_queue(unsigned int limit=0);
34 * \brief thread-safe message queue
37 class gr_msg_queue : public gr_msg_handler {
40 gruel::condition_variable d_not_empty;
41 gruel::condition_variable d_not_full;
42 gr_message_sptr d_head;
43 gr_message_sptr d_tail;
44 unsigned int d_count; // # of messages in queue.
45 unsigned int d_limit; // max # of messages in queue. 0 -> unbounded
48 gr_msg_queue(unsigned int limit);
51 //! Generic msg_handler method: insert the message.
52 void handle(gr_message_sptr msg) { insert_tail (msg); }
55 * \brief Insert message at tail of queue.
58 * Block if queue if full.
60 void insert_tail(gr_message_sptr msg);
63 * \brief Delete message from head of queue and return it.
64 * Block if no message is available.
66 gr_message_sptr delete_head();
69 * \brief If there's a message in the q, delete it and return it.
70 * If no message is available, return 0.
72 gr_message_sptr delete_head_nowait();
74 //! Delete all messages from the queue
77 //! is the queue empty?
78 bool empty_p() const { return d_count == 0; }
80 //! is the queue full?
81 bool full_p() const { return d_limit != 0 && d_count >= d_limit; }
83 //! return number of messages in queue
84 unsigned int count() const { return d_count; }
86 //! return limit on number of message in queue. 0 -> unbounded
87 unsigned int limit() const { return d_limit; }
91 #endif /* INCLUDED_GR_MSG_QUEUE_H */