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_accepter.h | |
| parent | e4f0319eced22c112f7e6a4cc45bc2036d285332 (diff) | |
| parent | 0fa219774dcf9141ae91204f948c029b05673f3f (diff) | |
Merged in next_docs branch.
Diffstat (limited to 'gnuradio-runtime/include/gnuradio/messages/msg_accepter.h')
| -rw-r--r-- | gnuradio-runtime/include/gnuradio/messages/msg_accepter.h | 56 |
1 files changed, 56 insertions, 0 deletions
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 */ |