GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
msg_producer.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012,2013 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
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)
10  * any later version.
11  *
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.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 
22 #ifndef INCLUDED_MSG_PRODUCER_H
23 #define INCLUDED_MSG_PRODUCER_H
24 
25 #include <gnuradio/api.h>
26 #include <pmt/pmt.h>
27 #include <boost/shared_ptr.hpp>
28 
29 namespace gr {
30  namespace messages {
31 
32  /*!
33  * \brief Virtual base class that produces messages
34  */
36  {
37  public:
39  virtual ~msg_producer();
40 
41  /*!
42  * \brief send \p msg to \p msg_producer
43  */
44  virtual pmt::pmt_t retrieve() = 0;
45  };
46 
47  typedef boost::shared_ptr<msg_producer> msg_producer_sptr;
48 
49  } /* namespace messages */
50 } /* namespace gr */
51 
52 #endif /* INCLUDED_MSG_PRODUCER_H */
Virtual base class that produces messages.
Definition: msg_producer.h:35
#define GR_RUNTIME_API
Definition: gnuradio-runtime/include/gnuradio/api.h:30
Include this header to use the message passing features.
Definition: logger.h:695
msg_producer()
Definition: msg_producer.h:38
boost::intrusive_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
Definition: pmt.h:56