Loading...
Searching...
No Matches
messages/msg_queue.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2009,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_MSG_QUEUE_H
#define INCLUDED_MSG_QUEUE_H
#include <gnuradio/api.h>
#include <gnuradio/thread/thread.h>
#include <pmt/pmt.h>
#include <deque>
namespace gr {
namespace messages {
class msg_queue;
typedef std::shared_ptr<msg_queue> msg_queue_sptr;
msg_queue_sptr make_msg_queue(unsigned int limit = 0);
/*!
* \brief thread-safe message queue
*/
class GR_RUNTIME_API msg_queue
{
private:
gr::thread::mutex d_mutex;
gr::thread::condition_variable d_not_empty;
gr::thread::condition_variable d_not_full;
unsigned int d_limit; // max # of messages in queue. 0 -> unbounded
std::deque<pmt::pmt_t> d_msgs;
public:
msg_queue(unsigned int limit);
~msg_queue();
/*!
* \brief Insert message at tail of queue.
* \param msg message
*
* Block if queue if full.
*/
void insert_tail(pmt::pmt_t msg);
/*!
* \brief Delete message from head of queue and return it.
* Block if no message is available.
*/
pmt::pmt_t delete_head();
/*!
* \brief If there's a message in the q, delete it and return it.
* If no message is available, return pmt::pmt_t().
*/
pmt::pmt_t delete_head_nowait();
//! Delete all messages from the queue
void flush();
//! is the queue empty?
bool empty_p() const { return d_msgs.empty(); }
//! is the queue full?
bool full_p() const { return d_limit != 0 && count() >= d_limit; }
//! return number of messages in queue
unsigned int count() const { return d_msgs.size(); }
//! return limit on number of message in queue. 0 -> unbounded
unsigned int limit() const { return d_limit; }
};
} /* namespace messages */
} /* namespace gr */
#endif /* INCLUDED_MSG_QUEUE_H */
gr::messages::msg_queue
thread-safe message queue
Definition messages/msg_queue.h:31
gr::messages::msg_queue::full_p
bool full_p() const
is the queue full?
Definition messages/msg_queue.h:71
gr::messages::msg_queue::delete_head_nowait
pmt::pmt_t delete_head_nowait()
If there's a message in the q, delete it and return it. If no message is available,...
gr::messages::msg_queue::flush
void flush()
Delete all messages from the queue.
gr::messages::msg_queue::empty_p
bool empty_p() const
is the queue empty?
Definition messages/msg_queue.h:68
gr::messages::msg_queue::~msg_queue
~msg_queue()
gr::messages::msg_queue::count
unsigned int count() const
return number of messages in queue
Definition messages/msg_queue.h:74
gr::messages::msg_queue::delete_head
pmt::pmt_t delete_head()
Delete message from head of queue and return it. Block if no message is available.
gr::messages::msg_queue::insert_tail
void insert_tail(pmt::pmt_t msg)
Insert message at tail of queue.
gr::messages::msg_queue::limit
unsigned int limit() const
return limit on number of message in queue. 0 -> unbounded
Definition messages/msg_queue.h:77
gr::messages::msg_queue::msg_queue
msg_queue(unsigned int limit)
api.h
GR_RUNTIME_API
#define GR_RUNTIME_API
Definition gnuradio-runtime/include/gnuradio/api.h:18
gr::messages
Definition messages/msg_accepter.h:19
gr::messages::make_msg_queue
msg_queue_sptr make_msg_queue(unsigned int limit=0)
gr::thread::mutex
boost::mutex mutex
Definition thread.h:37
gr::thread::condition_variable
boost::condition_variable condition_variable
Definition thread.h:39
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
pmt::pmt_t
std::shared_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting).
Definition pmt.h:83
pmt.h
thread.h