GNU Radio 3.5.1 C++ API
gr_message_source.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005 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
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_MESSAGE_SOURCE_H
00024 #define INCLUDED_GR_MESSAGE_SOURCE_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 #include <gr_message.h>
00029 #include <gr_msg_queue.h>
00030 
00031 class gr_message_source;
00032 typedef boost::shared_ptr<gr_message_source> gr_message_source_sptr;
00033 
00034 GR_CORE_API gr_message_source_sptr gr_make_message_source (size_t itemsize, int msgq_limit=0);
00035 GR_CORE_API gr_message_source_sptr gr_make_message_source (size_t itemsize, gr_msg_queue_sptr msgq);
00036 
00037 /*!
00038  * \brief Turn received messages into a stream
00039  * \ingroup source_blk
00040  */
00041 class GR_CORE_API gr_message_source : public gr_sync_block
00042 {
00043  private:
00044   size_t                d_itemsize;
00045   gr_msg_queue_sptr     d_msgq;
00046   gr_message_sptr       d_msg;
00047   unsigned              d_msg_offset;
00048   bool                  d_eof;
00049 
00050   friend GR_CORE_API gr_message_source_sptr
00051   gr_make_message_source(size_t itemsize, int msgq_limit);
00052   friend GR_CORE_API gr_message_source_sptr
00053   gr_make_message_source(size_t itemsize, gr_msg_queue_sptr msgq);
00054 
00055  protected:
00056   gr_message_source (size_t itemsize, int msgq_limit);
00057   gr_message_source (size_t itemsize, gr_msg_queue_sptr msgq);
00058 
00059  public:
00060   ~gr_message_source ();
00061 
00062   gr_msg_queue_sptr     msgq() const { return d_msgq; }
00063 
00064   int work (int noutput_items,
00065             gr_vector_const_void_star &input_items,
00066             gr_vector_void_star &output_items);
00067 };
00068 
00069 #endif /* INCLUDED_GR_MESSAGE_SOURCE_H */