gr_message_sink.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2005 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_GR_MESSAGE_SINK_H
#define INCLUDED_GR_MESSAGE_SINK_H

#include <gr_core_api.h>
#include <gr_sync_block.h>
#include <gr_message.h>
#include <gr_msg_queue.h>
#include <string>

class gr_message_sink;
typedef boost::shared_ptr<gr_message_sink> gr_message_sink_sptr;

GR_CORE_API gr_message_sink_sptr gr_make_message_sink (
  size_t itemsize,
  gr_msg_queue_sptr msgq,
  bool dont_block
);

GR_CORE_API gr_message_sink_sptr gr_make_message_sink (
  size_t itemsize,
  gr_msg_queue_sptr msgq,
  bool dont_block,
  const std::string& lengthtagname
);

/*!
 * \brief Gather received items into messages and insert into msgq
 * \ingroup sink_blk
 */
class GR_CORE_API gr_message_sink : public gr_sync_block
{
 private:
  size_t                d_itemsize;
  gr_msg_queue_sptr     d_msgq;
  bool                  d_dont_block;
  bool d_tags;
  std::string d_lengthtagname;
  uint64_t d_items_read;

  friend GR_CORE_API gr_message_sink_sptr
    gr_make_message_sink(size_t itemsize, gr_msg_queue_sptr msgq,
                         bool dont_block);
  friend GR_CORE_API gr_message_sink_sptr
    gr_make_message_sink(size_t itemsize, gr_msg_queue_sptr msgq,
                         bool dont_block, const std::string& lengthtagname);

 protected:
  gr_message_sink (size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block);
  gr_message_sink (size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block,
                   const std::string& lengthtagname);

 public:
  ~gr_message_sink ();

  int work (int noutput_items,
            gr_vector_const_void_star &input_items,
            gr_vector_void_star &output_items);
};

#endif /* INCLUDED_GR_MESSAGE_SINK_H */