diff options
author | Ben Reynwar <ben@reynwar.net> | 2013-05-19 02:55:33 -0700 |
---|---|---|
committer | Ben Reynwar <ben@reynwar.net> | 2013-05-19 02:55:33 -0700 |
commit | bb01988e75d50d82cbb44c1a49c86c1d08f05665 (patch) | |
tree | 0528dac14476d37f2cde7374a8fcb3428f879c69 /gnuradio-runtime/include/gnuradio/messages/msg_producer.h | |
parent | e4f0319eced22c112f7e6a4cc45bc2036d285332 (diff) | |
parent | 0fa219774dcf9141ae91204f948c029b05673f3f (diff) |
Merged in next_docs branch.
Diffstat (limited to 'gnuradio-runtime/include/gnuradio/messages/msg_producer.h')
-rw-r--r-- | gnuradio-runtime/include/gnuradio/messages/msg_producer.h | 52 |
1 files changed, 52 insertions, 0 deletions
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 */ |