GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
sub_source.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2013,2014 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio.
6 *
7 * This 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 * This software 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 this software; 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_ZEROMQ_SUB_SOURCE_H
24#define INCLUDED_ZEROMQ_SUB_SOURCE_H
25
26#include <gnuradio/sync_block.h>
27#include <gnuradio/zeromq/api.h>
28
29namespace gr {
30namespace zeromq {
31
32/*!
33 * \brief Receive messages on ZMQ SUB socket and source stream
34 * \ingroup zeromq
35 *
36 * \details
37 * This block will connect to a ZMQ PUB socket, then produce all
38 * incoming messages as streaming output.
39 */
40class ZEROMQ_API sub_source : virtual public gr::sync_block
41{
42public:
43 typedef boost::shared_ptr<sub_source> sptr;
44
45 /*!
46 * \brief Return a shared_ptr to a new instance of gr::zeromq::sub_source.
47 *
48 * \param itemsize Size of a stream item in bytes.
49 * \param vlen Vector length of the input items. Note that one vector is one item.
50 * \param address ZMQ socket address specifier.
51 * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
52 * \param pass_tags Whether source will look for and deserialize tags.
53 * \param hwm High Watermark to configure the socket to (-1 => zmq's default)
54 */
55 static sptr make(size_t itemsize,
56 size_t vlen,
57 char* address,
58 int timeout = 100,
59 bool pass_tags = false,
60 int hwm = -1);
61};
62
63} // namespace zeromq
64} // namespace gr
65
66#endif /* INCLUDED_ZEROMQ_SUB_SOURCE_H */
synchronous 1:1 input to output with history
Definition: sync_block.h:38
Receive messages on ZMQ SUB socket and source stream.
Definition: sub_source.h:41
static sptr make(size_t itemsize, size_t vlen, char *address, int timeout=100, bool pass_tags=false, int hwm=-1)
Return a shared_ptr to a new instance of gr::zeromq::sub_source.
boost::shared_ptr< sub_source > sptr
Definition: sub_source.h:43
#define ZEROMQ_API
Definition: gr-zeromq/include/gnuradio/zeromq/api.h:30
BLOCKS_API size_t itemsize(vector_type type)
Include this header to use the message passing features.
Definition: basic_block.h:45