GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
push_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_PUSH_MSG_SINK_H
24#define INCLUDED_ZEROMQ_PUSH_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 PUSH socket
34 * \ingroup zeromq
35 *
36 * \details
37 * This block acts a message port receiver and writes individual
38 * messages to a ZMQ PUSH socket. The corresponding receiving ZMQ
39 * PULL socket can be either another gr-zeromq source block or a
40 * non-GNU Radio ZMQ socket.
41 */
42class ZEROMQ_API push_msg_sink : virtual public gr::block
43{
44public:
45 typedef boost::shared_ptr<push_msg_sink> sptr;
46
47 /*!
48 * \brief Return a shared_ptr to a new instance of gr::zeromq::push_msg_sink
49 *
50 * \param address ZMQ socket address specifier
51 * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
52 * \param bind If true this block will bind to the address, otherwise it will
53 * connect; the default is to bind
54 *
55 */
56 static sptr make(char* address, int timeout = 100, bool bind = true);
57
58 /*!
59 * \brief Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
60 */
61 virtual std::string last_endpoint() = 0;
62};
63
64} // namespace zeromq
65} // namespace gr
66
67#endif /* INCLUDED_ZEROMQ_PUSH_MSG_SINK_H */
The abstract base class for all 'terminal' processing blocks.
Definition block.h:72
Sink the contents of a msg port to a ZMQ PUSH socket.
Definition push_msg_sink.h:43
static sptr make(char *address, int timeout=100, bool bind=true)
Return a shared_ptr to a new instance of gr::zeromq::push_msg_sink.
boost::shared_ptr< push_msg_sink > sptr
Definition push_msg_sink.h:45
virtual std::string last_endpoint()=0
Return a std::string of ZMQ_LAST_ENDPOINT from the underlying ZMQ socket.
#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