GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
pub_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_SINK_H
24 #define INCLUDED_ZEROMQ_PUB_SINK_H
25 
26 #include <gnuradio/zeromq/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace zeromq {
31 
32  /*!
33  * \brief Sink the contents of a stream to a ZMQ PUB 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 PUB socket. A PUB socket may
39  * have subscribers and will pass all incoming stream data to each
40  * subscriber. Subscribers can be either another gr-zeromq source
41  * block or a non-GNU Radio ZMQ socket.
42  */
43  class ZEROMQ_API pub_sink : virtual public gr::sync_block
44  {
45  public:
46  typedef boost::shared_ptr<pub_sink> sptr;
47 
48  /*!
49  * \brief Return a shared_ptr to a new instance of zeromq::pub_sink.
50  *
51  * \param itemsize Size of a stream item in bytes.
52  * \param vlen Vector length of the input items. Note that one vector is one item.
53  * \param address ZMQ socket address specifier.
54  * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
55  * \param pass_tags Whether sink will serialize and pass tags over the link.
56  * \param hwm High Watermark to configure the socket to (-1 => zmq's default)
57  */
58  static sptr make(size_t itemsize, size_t vlen, char *address,
59  int timeout=100, bool pass_tags=false, int hwm=-1);
60  };
61 
62  } // namespace zeromq
63 } // namespace gr
64 
65 #endif /* INCLUDED_ZEROMQ_PUB_SINK_H */
boost::shared_ptr< pub_sink > sptr
Definition: pub_sink.h:46
#define ZEROMQ_API
Definition: gr-zeromq/include/gnuradio/zeromq/api.h:30
Sink the contents of a stream to a ZMQ PUB socket.
Definition: pub_sink.h:43
Include this header to use the message passing features.
Definition: logger.h:131
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
BLOCKS_API size_t itemsize(vector_type type)