GNU Radio 3.7.1 C++ API
msg_producer.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License along
00018  * with this program; if not, write to the Free Software Foundation, Inc.,
00019  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00020  */
00021 
00022 #ifndef INCLUDED_MSG_PRODUCER_H
00023 #define INCLUDED_MSG_PRODUCER_H
00024 
00025 #include <gnuradio/api.h>
00026 #include <pmt/pmt.h>
00027 #include <boost/shared_ptr.hpp>
00028 
00029 namespace gr {
00030   namespace messages {
00031 
00032     /*!
00033      * \brief Virtual base class that produces messages
00034      */
00035     class GR_RUNTIME_API msg_producer
00036     {
00037     public:
00038       msg_producer() {}
00039       virtual ~msg_producer();
00040 
00041       /*!
00042        * \brief send \p msg to \p msg_producer
00043        */
00044       virtual pmt::pmt_t retrieve() = 0;
00045     };
00046 
00047     typedef boost::shared_ptr<msg_producer> msg_producer_sptr;
00048     
00049   } /* namespace messages */
00050 } /* namespace gr */
00051 
00052 #endif /* INCLUDED_MSG_PRODUCER_H */