GNU Radio 3.5.3.2 C++ API
gr_message_sink.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_SINK_H
00024 #define INCLUDED_GR_MESSAGE_SINK_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_sink;
00032 typedef boost::shared_ptr<gr_message_sink> gr_message_sink_sptr;
00033 
00034 GR_CORE_API gr_message_sink_sptr gr_make_message_sink (size_t itemsize,
00035                                            gr_msg_queue_sptr msgq,
00036                                            bool dont_block);
00037 
00038 /*!
00039  * \brief Gather received items into messages and insert into msgq
00040  * \ingroup sink_blk
00041  */
00042 class GR_CORE_API gr_message_sink : public gr_sync_block
00043 {
00044  private:
00045   size_t                d_itemsize;
00046   gr_msg_queue_sptr     d_msgq;
00047   bool                  d_dont_block;
00048 
00049   friend GR_CORE_API gr_message_sink_sptr
00050   gr_make_message_sink(size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block);
00051 
00052  protected:
00053   gr_message_sink (size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block);
00054 
00055  public:
00056   ~gr_message_sink ();
00057 
00058   int work (int noutput_items,
00059             gr_vector_const_void_star &input_items,
00060             gr_vector_void_star &output_items);
00061 };
00062 
00063 #endif /* INCLUDED_GR_MESSAGE_SINK_H */