diff options
Diffstat (limited to 'gnuradio-runtime/include/gnuradio/messages')
6 files changed, 410 insertions, 0 deletions
diff --git a/gnuradio-runtime/include/gnuradio/messages/CMakeLists.txt b/gnuradio-runtime/include/gnuradio/messages/CMakeLists.txt new file mode 100644 index 0000000000..f79f2bd24f --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/messages/CMakeLists.txt @@ -0,0 +1,31 @@ +# Copyright 2013 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 3, 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., 51 Franklin Street, +# Boston, MA 02110-1301, USA. + +######################################################################## +# Install header files +######################################################################## +install(FILES + msg_accepter.h + msg_accepter_msgq.h + msg_passing.h + msg_producer.h + msg_queue.h + DESTINATION ${GR_INCLUDE_DIR}/gnuradio/messages + COMPONENT "runtime_devel" +) diff --git a/gnuradio-runtime/include/gnuradio/messages/msg_accepter.h b/gnuradio-runtime/include/gnuradio/messages/msg_accepter.h new file mode 100644 index 0000000000..cd87b21dec --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/messages/msg_accepter.h @@ -0,0 +1,56 @@ +/* -*- c++ -*- */ +/* + * Copyright 2009,2013 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 3, 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 this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef INCLUDED_MSG_ACCEPTER_H +#define INCLUDED_MSG_ACCEPTER_H + +#include <gnuradio/api.h> +#include <pmt/pmt.h> +#include <boost/shared_ptr.hpp> + +namespace gr { + namespace messages { + + /*! + * \brief Virtual base class that accepts messages + */ + class GR_RUNTIME_API msg_accepter + { + public: + msg_accepter() {}; + virtual ~msg_accepter(); + + /*! + * \brief send \p msg to \p msg_accepter on port \p which_port + * + * Sending a message is an asynchronous operation. The \p post + * call will not wait for the message either to arrive at the + * destination or to be received. + */ + virtual void post(pmt::pmt_t which_port, pmt::pmt_t msg) = 0; + }; + + typedef boost::shared_ptr<msg_accepter> msg_accepter_sptr; + + } /* namespace messages */ +} /* namespace gr */ + +#endif /* INCLUDED_MSG_ACCEPTER_H */ diff --git a/gnuradio-runtime/include/gnuradio/messages/msg_accepter_msgq.h b/gnuradio-runtime/include/gnuradio/messages/msg_accepter_msgq.h new file mode 100644 index 0000000000..ba699b8ee6 --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/messages/msg_accepter_msgq.h @@ -0,0 +1,53 @@ +/* -*- c++ -*- */ +/* + * Copyright 2009,2013 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 3, 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 this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef INCLUDED_MSG_ACCEPTER_MSGQ_H +#define INCLUDED_MSG_ACCEPTER_MSGQ_H + +#include <gnuradio/api.h> +#include <gnuradio/messages/msg_accepter.h> +#include <gnuradio/messages/msg_queue.h> + +namespace gr { + namespace messages { + + /*! + * \brief Concrete class that accepts messages and inserts them + * into a message queue. + */ + class GR_RUNTIME_API msg_accepter_msgq : public msg_accepter + { + protected: + msg_queue_sptr d_msg_queue; + + public: + msg_accepter_msgq(msg_queue_sptr msgq); + ~msg_accepter_msgq(); + + virtual void post(pmt::pmt_t msg); + + msg_queue_sptr msg_queue() const { return d_msg_queue; } + }; + + } /* namespace messages */ +} /* namespace gr */ + +#endif /* INCLUDED_MSG_ACCEPTER_MSGQ_H */ diff --git a/gnuradio-runtime/include/gnuradio/messages/msg_passing.h b/gnuradio-runtime/include/gnuradio/messages/msg_passing.h new file mode 100644 index 0000000000..6ad6c40b08 --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/messages/msg_passing.h @@ -0,0 +1,123 @@ +/* -*- c++ -*- */ +/* + * Copyright 2009,2013 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 3, 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 this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef INCLUDED_MSG_PASSING_H +#define INCLUDED_MSG_PASSING_H + +/*! + * \brief Include this header to use the message passing features + */ + +#include <gnuradio/api.h> +#include <pmt/pmt.h> +#include <gnuradio/messages/msg_accepter.h> + +namespace gr { + namespace messages { + + /*! + * \brief send message to msg_accepter + * + * \param accepter is the target of the send. + * \param which_port A pmt symbol describing the port by name. + * \param msg is the message to send. It's usually a pmt tuple. + * + * Sending a message is an asynchronous operation. The \p send + * call will not wait for the message either to arrive at the + * destination or to be received. + * + * \returns msg + */ + static inline pmt::pmt_t + send(msg_accepter_sptr accepter, const pmt::pmt_t &which_port, + const pmt::pmt_t &msg) + { + accepter->post(which_port, msg); + return msg; + } + + /*! + * \brief send message to msg_accepter + * + * \param accepter is the target of the send. + * \param which_port A pmt symbol describing the port by name. + * \param msg is the message to send. It's usually a pmt tuple. + * + * Sending a message is an asynchronous operation. The \p send + * call will not wait for the message either to arrive at the + * destination or to be received. + * + * \returns msg + */ + static inline pmt::pmt_t + send(msg_accepter *accepter, const pmt::pmt_t &which_port, + const pmt::pmt_t &msg) + { + accepter->post(which_port, msg); + return msg; + } + + /*! + * \brief send message to msg_accepter + * + * \param accepter is the target of the send. + * \param which_port A pmt symbol describing the port by name. + * \param msg is the message to send. It's usually a pmt tuple. + * + * Sending a message is an asynchronous operation. The \p send + * call will not wait for the message either to arrive at the + * destination or to be received. + * + * \returns msg + */ + static inline pmt::pmt_t + send(msg_accepter &accepter, const pmt::pmt_t &which_port, + const pmt::pmt_t &msg) + { + accepter.post(which_port, msg); + return msg; + } + + /*! + * \brief send message to msg_accepter + * + * \param accepter is the target of the send. + * aprecond: pmt::is_msg_accepter(accepter) + * \param which_port A pmt symbol describing the port by name. + * \param msg is the message to send. It's usually a pmt tuple. + * + * Sending a message is an asynchronous operation. The \p send + * call will not wait for the message either to arrive at the + * destination or to be received. + * + * \returns msg + */ + static inline pmt::pmt_t + send(pmt::pmt_t accepter, const pmt::pmt_t &which_port, + const pmt::pmt_t &msg) + { + return send(pmt::msg_accepter_ref(accepter), which_port, msg); + } + + } /* namespace messages */ +} /* namespace gr */ + +#endif /* INCLUDED_MSG_PASSING_H */ diff --git a/gnuradio-runtime/include/gnuradio/messages/msg_producer.h b/gnuradio-runtime/include/gnuradio/messages/msg_producer.h new file mode 100644 index 0000000000..758320fc6a --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/messages/msg_producer.h @@ -0,0 +1,52 @@ +/* -*- c++ -*- */ +/* + * Copyright 2012,2013 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 3, 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 this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef INCLUDED_MSG_PRODUCER_H +#define INCLUDED_MSG_PRODUCER_H + +#include <gnuradio/api.h> +#include <pmt/pmt.h> +#include <boost/shared_ptr.hpp> + +namespace gr { + namespace messages { + + /*! + * \brief Virtual base class that produces messages + */ + class GR_RUNTIME_API msg_producer + { + public: + msg_producer() {} + virtual ~msg_producer(); + + /*! + * \brief send \p msg to \p msg_producer + */ + virtual pmt::pmt_t retrieve() = 0; + }; + + typedef boost::shared_ptr<msg_producer> msg_producer_sptr; + + } /* namespace messages */ +} /* namespace gr */ + +#endif /* INCLUDED_MSG_PRODUCER_H */ diff --git a/gnuradio-runtime/include/gnuradio/messages/msg_queue.h b/gnuradio-runtime/include/gnuradio/messages/msg_queue.h new file mode 100644 index 0000000000..dfe1ca97be --- /dev/null +++ b/gnuradio-runtime/include/gnuradio/messages/msg_queue.h @@ -0,0 +1,95 @@ +/* -*- c++ -*- */ +/* + * Copyright 2009,2013 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 3, 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., 51 Franklin Street, + * Boston, MA 02110-1301, USA. + */ + +#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 boost::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 */ |