GNU Radio C++ API Reference 3.10.12.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
req_source.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio.
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_ZEROMQ_REQ_SOURCE_H
12#define INCLUDED_ZEROMQ_REQ_SOURCE_H
13
14#include <gnuradio/sync_block.h>
15#include <gnuradio/zeromq/api.h>
16
17namespace gr {
18namespace zeromq {
19
20/*!
21 * \brief Receive messages on ZMQ REQ socket and source stream
22 * \ingroup zeromq
23 *
24 * \details
25 * This block will connect to a ZMQ REP socket, then produce all
26 * incoming messages as streaming output.
27 */
28class ZEROMQ_API req_source : virtual public gr::sync_block
29{
30public:
31 typedef std::shared_ptr<req_source> sptr;
32
33 /*!
34 * \brief Return a shared_ptr to a new instance of zeromq::req_source.
35 *
36 * \param itemsize Size of a stream item in bytes.
37 * \param vlen Vector length of the input items. Note that one vector is one item.
38 * \param address ZMQ socket address specifier.
39 * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
40 * \param pass_tags Whether source will look for and deserialize tags.
41 * \param hwm High Watermark to configure the socket to (-1 => zmq's default)
42 * \param bind If true this block will bind to the address, otherwise it will
43 * connect; the default is to connect
44 */
45 static sptr make(size_t itemsize,
46 size_t vlen,
47 char* address,
48 int timeout = 100,
49 bool pass_tags = false,
50 int hwm = -1,
51 bool bind = false);
52
53 /*!
54 * \brief Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
55 */
56 virtual std::string last_endpoint() = 0;
57};
58
59} // namespace zeromq
60} // namespace gr
61
62#endif /* INCLUDED_ZEROMQ_SOURCE_REQREP_H */
synchronous 1:1 input to output with history
Definition sync_block.h:26
Receive messages on ZMQ REQ socket and source stream.
Definition req_source.h:29
virtual std::string last_endpoint()=0
Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
std::shared_ptr< req_source > sptr
Definition req_source.h:31
static sptr make(size_t itemsize, size_t vlen, char *address, int timeout=100, bool pass_tags=false, int hwm=-1, bool bind=false)
Return a shared_ptr to a new instance of zeromq::req_source.
#define ZEROMQ_API
Definition gr-zeromq/include/gnuradio/zeromq/api.h:18
GNU Radio logging wrapper.
Definition basic_block.h:29