git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/gr_message_sink.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005 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 2, 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
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifndef INCLUDED_GR_MESSAGE_SINK_H
  24 #define INCLUDED_GR_MESSAGE_SINK_H
  25
  26 #include <gr_sync_block.h>
  27 #include <gr_message.h>
  28 #include <gr_msg_queue.h>
  29
  30 class gr_message_sink;
  31 typedef boost::shared_ptr<gr_message_sink> gr_message_sink_sptr;
  32
  33 gr_message_sink_sptr gr_make_message_sink (size_t itemsize,
  34                                            gr_msg_queue_sptr msgq,
  35                                            bool dont_block);
  36
  37 /*!
  38  * \brief Gather received items into messages and insert into msgq
  39  * \ingroup sink
  40  */
  41 class gr_message_sink : public gr_sync_block
  42 {
  43  private:
  44   size_t                d_itemsize;
  45   gr_msg_queue_sptr     d_msgq;
  46   bool                  d_dont_block;
  47
  48   friend gr_message_sink_sptr
  49   gr_make_message_sink(size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block);
  50
  51  protected:
  52   gr_message_sink (size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block);
  53
  54  public:
  55   ~gr_message_sink ();
  56
  57   int work (int noutput_items,
  58             gr_vector_const_void_star &input_items,
  59             gr_vector_void_star &output_items);
  60 };
  61
  62 #endif /* INCLUDED_GR_MESSAGE_SINK_H */