summaryrefslogtreecommitdiff
path: root/gr-zeromq/include/gnuradio
diff options
context:
space:
mode:
authorCamilo Solano <solano@ti.rwth-aachen.de>2014-05-06 19:45:05 +0200
committerCamilo Solano <solano@ti.rwth-aachen.de>2014-05-06 19:52:03 +0200
commit35aaec4d0d4b6f995911fd6d38697bc239cd68cf (patch)
tree0679d75ea8eabacaf6150039ce8840bd1d4735d4 /gr-zeromq/include/gnuradio
parentedd1405c7f2bcd79e8fb5aa72189e13a37c1ed02 (diff)
zeromq: renamed source_reqrep to req_source
Diffstat (limited to 'gr-zeromq/include/gnuradio')
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/CMakeLists.txt2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/req_source.h (renamed from gr-zeromq/include/gnuradio/zeromq/source_reqrep.h)25
2 files changed, 16 insertions, 11 deletions
diff --git a/gr-zeromq/include/gnuradio/zeromq/CMakeLists.txt b/gr-zeromq/include/gnuradio/zeromq/CMakeLists.txt
index 82088c6b6b..7a5b229419 100644
--- a/gr-zeromq/include/gnuradio/zeromq/CMakeLists.txt
+++ b/gr-zeromq/include/gnuradio/zeromq/CMakeLists.txt
@@ -26,10 +26,10 @@ install(FILES
pull_source.h
push_sink.h
rep_sink.h
+ req_source.h
DESTINATION ${GR_INCLUDE_DIR}/gnuradio/zeromq
COMPONENT "zeromq_devel"
)
# sink_reqrep_nopoll.h
-# source_reqrep.h
# source_reqrep_nopoll.h
diff --git a/gr-zeromq/include/gnuradio/zeromq/source_reqrep.h b/gr-zeromq/include/gnuradio/zeromq/req_source.h
index 54d4b8da21..5d3f380f8b 100644
--- a/gr-zeromq/include/gnuradio/zeromq/source_reqrep.h
+++ b/gr-zeromq/include/gnuradio/zeromq/req_source.h
@@ -20,8 +20,8 @@
* Boston, MA 02110-1301, USA.
*/
-#ifndef INCLUDED_ZEROMQ_SOURCE_REQREP_H
-#define INCLUDED_ZEROMQ_SOURCE_REQREP_H
+#ifndef INCLUDED_ZEROMQ_REQ_SOURCE_H
+#define INCLUDED_ZEROMQ_REQ_SOURCE_H
#include <gnuradio/zeromq/api.h>
#include <gnuradio/sync_block.h>
@@ -30,22 +30,27 @@ namespace gr {
namespace zeromq {
/*!
- * \brief <+description of block+>
+ * \brief Receive messages on ZMQ REQ socket and source stream
* \ingroup zeromq
*
+ * \details
+ * This block will connect to a ZMQ REP socket, then produce all
+ * incoming messages as streaming output.
*/
- class ZEROMQ_API source_reqrep : virtual public gr::sync_block
+ class ZEROMQ_API req_source : virtual public gr::sync_block
{
public:
- typedef boost::shared_ptr<source_reqrep> sptr;
+ typedef boost::shared_ptr<req_source> sptr;
/*!
- * \brief Return a shared_ptr to a new instance of zeromq::source_reqrep.
+ * \brief Return a shared_ptr to a new instance of zeromq::req_source.
+ *
+ *
+ * \param itemsize Size of a stream item in bytes
+ * \param vlen of the input items.
+ * \param address ZMQ socket address specifier
+ * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
*
- * To avoid accidental use of raw pointers, zeromq::source_reqrep's
- * constructor is in a private implementation
- * class. zeromq::source_reqrep::make is the public interface for
- * creating new instances.
*/
static sptr make(size_t itemsize, size_t vlen, char *address);
};