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
pull_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  * 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_PULL_MSG_SOURCE_H
24 #define INCLUDED_ZEROMQ_PULL_MSG_SOURCE_H
25 
26 #include <gnuradio/zeromq/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace zeromq {
31 
32  /*!
33  * \brief Receive messages on ZMQ PULL socket and output async messages
34  * \ingroup zeromq
35  *
36  * \details
37  * This block will connect to a ZMQ PUSH socket, then convert
38  * received messages to outgoing async messages.
39  */
40  class ZEROMQ_API pull_msg_source : virtual public gr::block
41  {
42  public:
43  typedef boost::shared_ptr<pull_msg_source> sptr;
44 
45  /*!
46  * \brief Return a shared_ptr to a new instance of gr::zeromq::pull_msg_source.
47  *
48  * \param address ZMQ socket address specifier
49  * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
50  *
51  */
52  static sptr make(char *address, int timeout=100);
53  };
54 
55  } // namespace zeromq
56 } // namespace gr
57 
58 #endif /* INCLUDED_ZEROMQ_PULL_MSG_SOURCE_H */
#define ZEROMQ_API
Definition: gr-zeromq/include/gnuradio/zeromq/api.h:30
Include this header to use the message passing features.
Definition: logger.h:131
Receive messages on ZMQ PULL socket and output async messages.
Definition: pull_msg_source.h:40
The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...
Definition: block.h:60
boost::shared_ptr< pull_msg_source > sptr
Definition: pull_msg_source.h:43