GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
sub_msg_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  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_ZEROMQ_SUB_MSG_SOURCE_H
12 #define INCLUDED_ZEROMQ_SUB_MSG_SOURCE_H
13 
14 #include <gnuradio/block.h>
15 #include <gnuradio/zeromq/api.h>
16 
17 namespace gr {
18 namespace zeromq {
19 
20 /*!
21  * \brief Receive messages on ZMQ SUB socket and output async messages
22  * \ingroup zeromq
23  *
24  * \details
25  * This block will connect to a ZMQ PUB socket, then convert them
26  * to outgoing async messages
27  */
28 class ZEROMQ_API sub_msg_source : virtual public gr::block
29 {
30 public:
31  typedef std::shared_ptr<sub_msg_source> sptr;
32 
33  /*!
34  * \brief Return a shared_ptr to a new instance of gr::zeromq::sub_msg_source.
35  *
36  * \param address ZMQ socket address specifier
37  * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
38  * \param bind If true this block will bind to the address, otherwise it will
39  * connect; the default is to connect
40  *
41  */
42  static sptr make(char* address, int timeout = 100, bool bind = false);
43 
44  /*!
45  * \brief Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
46  */
47  virtual std::string last_endpoint() = 0;
48 };
49 
50 } // namespace zeromq
51 } // namespace gr
52 
53 #endif /* INCLUDED_ZEROMQ_SUB_MSG_SOURCE_H */
The abstract base class for all 'terminal' processing blocks.
Definition: gnuradio-runtime/include/gnuradio/block.h:63
Receive messages on ZMQ SUB socket and output async messages.
Definition: sub_msg_source.h:29
virtual std::string last_endpoint()=0
Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
static sptr make(char *address, int timeout=100, bool bind=false)
Return a shared_ptr to a new instance of gr::zeromq::sub_msg_source.
std::shared_ptr< sub_msg_source > sptr
Definition: sub_msg_source.h:31
#define ZEROMQ_API
Definition: gr-zeromq/include/gnuradio/zeromq/api.h:18
GNU Radio logging wrapper.
Definition: basic_block.h:29