GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
pub_msg_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_PUB_MSG_SINK_H
24#define INCLUDED_ZEROMQ_PUB_MSG_SINK_H
25
26#include <gnuradio/block.h>
27#include <gnuradio/zeromq/api.h>
28
29namespace gr {
30namespace zeromq {
31
32/*!
33 * \brief Sink the contents of a msg port to a ZMQ PUB socket
34 * \ingroup zeromq
35 *
36 * \details
37 * This block acts a message port receiver and writes individual
38 * messages to a ZMQ PUB socket. A PUB socket may have
39 * subscribers and will pass all incoming messages to each
40 * subscriber. Subscribers can be either another gr-zeromq source
41 * block or a non-GNU Radio ZMQ socket.
42 */
43class ZEROMQ_API pub_msg_sink : virtual public gr::block
44{
45public:
46 typedef boost::shared_ptr<pub_msg_sink> sptr;
47
48 /*!
49 * \brief Return a shared_ptr to a new instance of zeromq::pub_msg_sink.
50 *
51 * \param address ZMQ socket address specifier
52 * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
53 */
54 static sptr make(char* address, int timeout = 100);
55};
56
57} // namespace zeromq
58} // namespace gr
59
60#endif /* INCLUDED_ZEROMQ_PUB_MSG_SINK_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
Sink the contents of a msg port to a ZMQ PUB socket.
Definition: pub_msg_sink.h:44
boost::shared_ptr< pub_msg_sink > sptr
Definition: pub_msg_sink.h:46
static sptr make(char *address, int timeout=100)
Return a shared_ptr to a new instance of zeromq::pub_msg_sink.
#define ZEROMQ_API
Definition: gr-zeromq/include/gnuradio/zeromq/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45