GNU Radio 3.6.5.1 C++ API
gr_message_sink.h
Go to the documentation of this file.
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 3, 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_core_api.h>
27 #include <gr_sync_block.h>
28 #include <gr_message.h>
29 #include <gr_msg_queue.h>
30 #include <string>
31 
32 class gr_message_sink;
34 
36  size_t itemsize,
37  gr_msg_queue_sptr msgq,
38  bool dont_block
39 );
40 
42  size_t itemsize,
43  gr_msg_queue_sptr msgq,
44  bool dont_block,
45  const std::string& lengthtagname
46 );
47 
48 /*!
49  * \brief Gather received items into messages and insert into msgq
50  * \ingroup sink_blk
51  */
53 {
54  private:
55  size_t d_itemsize;
56  gr_msg_queue_sptr d_msgq;
57  bool d_dont_block;
58  bool d_tags;
59  std::string d_lengthtagname;
60  uint64_t d_items_read;
61 
64  bool dont_block);
66  gr_make_message_sink(size_t itemsize, gr_msg_queue_sptr msgq,
67  bool dont_block, const std::string& lengthtagname);
68 
69  protected:
70  gr_message_sink (size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block);
71  gr_message_sink (size_t itemsize, gr_msg_queue_sptr msgq, bool dont_block,
72  const std::string& lengthtagname);
73 
74  public:
75  ~gr_message_sink ();
76 
77  int work (int noutput_items,
78  gr_vector_const_void_star &input_items,
79  gr_vector_void_star &output_items);
80 };
81 
82 #endif /* INCLUDED_GR_MESSAGE_SINK_H */