GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
push_sink.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_PUSH_SINK_H
24#define INCLUDED_ZEROMQ_PUSH_SINK_H
25
26#include <gnuradio/sync_block.h>
27#include <gnuradio/zeromq/api.h>
28
29namespace gr {
30namespace zeromq {
31
32/*!
33 * \brief Sink the contents of a stream to a ZMQ PUSH socket
34 * \ingroup zeromq
35 *
36 * \details
37 * This block acts a a streaming sink for a GNU Radio flowgraph
38 * and writes its contents to a ZMQ PUSH socket. A PUSH socket
39 * will round-robin send its messages to each connected ZMQ PULL
40 * socket, either another gr-zeromq source block or a regular,
41 * non-GNU Radio ZMQ socket.
42 *
43 */
44class ZEROMQ_API push_sink : virtual public gr::sync_block
45{
46public:
47 typedef boost::shared_ptr<push_sink> sptr;
48
49 /*!
50 * \brief Return a shared_ptr to a new instance of gr::zeromq::push_sink
51 *
52 * \param itemsize Size of a stream item in bytes.
53 * \param vlen Vector length of the input items. Note that one vector is one item.
54 * \param address ZMQ socket address specifier.
55 * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
56 * \param pass_tags Whether sink will serialize and pass tags over the link.
57 * \param hwm High Watermark to configure the socket to (-1 => zmq's default)
58 */
59 static sptr make(size_t itemsize,
60 size_t vlen,
61 char* address,
62 int timeout = 100,
63 bool pass_tags = false,
64 int hwm = -1);
65
66 /*!
67 * \brief Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
68 */
69 virtual std::string last_endpoint() = 0;
70};
71
72} // namespace zeromq
73} // namespace gr
74
75#endif /* INCLUDED_ZEROMQ_PUSH_SINK_H */
synchronous 1:1 input to output with history
Definition sync_block.h:38
Sink the contents of a stream to a ZMQ PUSH socket.
Definition push_sink.h:45
virtual std::string last_endpoint()=0
Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
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::push_sink.
boost::shared_ptr< push_sink > sptr
Definition push_sink.h:47
#define ZEROMQ_API
Definition gr-zeromq/include/gnuradio/zeromq/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46