GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
null_sink.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2010,2013 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_NULL_SINK_H
24#define INCLUDED_GR_NULL_SINK_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28#include <stddef.h> // size_t
29
30namespace gr {
31namespace blocks {
32
33/*!
34 * \brief Bit bucket. Use as a termination point when a sink is
35 * required and we don't want to do anything real.
36 * \ingroup misc_blk
37 */
38class BLOCKS_API null_sink : virtual public sync_block
39{
40public:
41 // gr::blocks::null_sink::sptr
42 typedef boost::shared_ptr<null_sink> sptr;
43
44 /*!
45 * Build a null sink block.
46 *
47 * \param sizeof_stream_item size of the stream items in bytes.
48 */
49 static sptr make(size_t sizeof_stream_item);
50};
51
52} /* namespace blocks */
53} /* namespace gr */
54
55#endif /* INCLUDED_GR_NULL_SINK_H */
Bit bucket. Use as a termination point when a sink is required and we don't want to do anything real.
Definition: null_sink.h:39
boost::shared_ptr< null_sink > sptr
Definition: null_sink.h:42
static sptr make(size_t sizeof_stream_item)
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45