summaryrefslogtreecommitdiff
path: root/gr-zeromq
diff options
context:
space:
mode:
authorMarc L <marcll@vt.edu>2017-08-29 21:04:57 -0400
committerMarc L <marcll@vt.edu>2017-08-29 21:04:57 -0400
commit7ba0077f049e66bf77794253e83955af5ce5426d (patch)
tree479462ad41c9498f5535a412a3a3096b196c4262 /gr-zeromq
parentec71327d2949649866d85b1b80356481693ca38e (diff)
docs: fixed units of timeout param in all the zmq blocks
Diffstat (limited to 'gr-zeromq')
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/pub_msg_sink.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/pub_sink.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/pull_msg_source.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/pull_source.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/push_msg_sink.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/push_sink.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/rep_msg_sink.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/rep_sink.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/req_msg_source.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/req_source.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/sub_msg_source.h2
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/sub_source.h2
12 files changed, 12 insertions, 12 deletions
diff --git a/gr-zeromq/include/gnuradio/zeromq/pub_msg_sink.h b/gr-zeromq/include/gnuradio/zeromq/pub_msg_sink.h
index 8cf4bcfab4..fb046ca84b 100644
--- a/gr-zeromq/include/gnuradio/zeromq/pub_msg_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/pub_msg_sink.h
@@ -49,7 +49,7 @@ namespace gr {
* \brief Return a shared_ptr to a new instance of zeromq::pub_msg_sink.
*
* \param address ZMQ socket address specifier
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
*/
static sptr make(char *address, int timeout=100);
};
diff --git a/gr-zeromq/include/gnuradio/zeromq/pub_sink.h b/gr-zeromq/include/gnuradio/zeromq/pub_sink.h
index e87c5522f9..3fecc10b59 100644
--- a/gr-zeromq/include/gnuradio/zeromq/pub_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/pub_sink.h
@@ -51,7 +51,7 @@ namespace gr {
* \param itemsize Size of a stream item in bytes.
* \param vlen Vector length of the input items. Note that one vector is one item.
* \param address ZMQ socket address specifier.
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
* \param pass_tags Whether sink will serialize and pass tags over the link.
* \param hwm High Watermark to configure the socket to (-1 => zmq's default)
*/
diff --git a/gr-zeromq/include/gnuradio/zeromq/pull_msg_source.h b/gr-zeromq/include/gnuradio/zeromq/pull_msg_source.h
index 17495152b8..13857ead5f 100644
--- a/gr-zeromq/include/gnuradio/zeromq/pull_msg_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/pull_msg_source.h
@@ -46,7 +46,7 @@ namespace gr {
* \brief Return a shared_ptr to a new instance of gr::zeromq::pull_msg_source.
*
* \param address ZMQ socket address specifier
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
*
*/
static sptr make(char *address, int timeout=100);
diff --git a/gr-zeromq/include/gnuradio/zeromq/pull_source.h b/gr-zeromq/include/gnuradio/zeromq/pull_source.h
index 07cf6af128..ecfe508b0a 100644
--- a/gr-zeromq/include/gnuradio/zeromq/pull_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/pull_source.h
@@ -48,7 +48,7 @@ namespace gr {
* \param itemsize Size of a stream item in bytes.
* \param vlen Vector length of the input items. Note that one vector is one item.
* \param address ZMQ socket address specifier.
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
* \param pass_tags Whether source will look for and deserialize tags.
* \param hwm High Watermark to configure the socket to (-1 => zmq's default)
*/
diff --git a/gr-zeromq/include/gnuradio/zeromq/push_msg_sink.h b/gr-zeromq/include/gnuradio/zeromq/push_msg_sink.h
index 3ce6ebbdc0..941ad549f5 100644
--- a/gr-zeromq/include/gnuradio/zeromq/push_msg_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/push_msg_sink.h
@@ -48,7 +48,7 @@ namespace gr {
* \brief Return a shared_ptr to a new instance of gr::zeromq::push_msg_sink
*
* \param address ZMQ socket address specifier
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
*
*/
static sptr make(char *address, int timeout=100);
diff --git a/gr-zeromq/include/gnuradio/zeromq/push_sink.h b/gr-zeromq/include/gnuradio/zeromq/push_sink.h
index e2260aa3f6..f81dcaa941 100644
--- a/gr-zeromq/include/gnuradio/zeromq/push_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/push_sink.h
@@ -52,7 +52,7 @@ namespace gr {
* \param itemsize Size of a stream item in bytes.
* \param vlen Vector length of the input items. Note that one vector is one item.
* \param address ZMQ socket address specifier.
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
* \param pass_tags Whether sink will serialize and pass tags over the link.
* \param hwm High Watermark to configure the socket to (-1 => zmq's default)
*/
diff --git a/gr-zeromq/include/gnuradio/zeromq/rep_msg_sink.h b/gr-zeromq/include/gnuradio/zeromq/rep_msg_sink.h
index 97f3d831ad..d11550d149 100644
--- a/gr-zeromq/include/gnuradio/zeromq/rep_msg_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/rep_msg_sink.h
@@ -48,7 +48,7 @@ namespace gr {
* \brief Return a shared_ptr to a new instance of zeromq::rep_msg_sink.
*
* \param address ZMQ socket address specifier
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
*
*/
static sptr make(char *address, int timeout=100);
diff --git a/gr-zeromq/include/gnuradio/zeromq/rep_sink.h b/gr-zeromq/include/gnuradio/zeromq/rep_sink.h
index 220bd34416..c1d2d370fc 100644
--- a/gr-zeromq/include/gnuradio/zeromq/rep_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/rep_sink.h
@@ -50,7 +50,7 @@ namespace gr {
* \param itemsize Size of a stream item in bytes.
* \param vlen Vector length of the input items. Note that one vector is one item.
* \param address ZMQ socket address specifier.
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
* \param pass_tags Whether sink will serialize and pass tags over the link.
* \param hwm High Watermark to configure the socket to (-1 => zmq's default)
*/
diff --git a/gr-zeromq/include/gnuradio/zeromq/req_msg_source.h b/gr-zeromq/include/gnuradio/zeromq/req_msg_source.h
index 05d80b8e7f..28ac9f84f3 100644
--- a/gr-zeromq/include/gnuradio/zeromq/req_msg_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/req_msg_source.h
@@ -46,7 +46,7 @@ namespace gr {
* \brief Return a shared_ptr to a new instance of zeromq::req_msg_source.
*
* \param address ZMQ socket address specifier
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
*
*/
static sptr make(char *address, int timeout=100);
diff --git a/gr-zeromq/include/gnuradio/zeromq/req_source.h b/gr-zeromq/include/gnuradio/zeromq/req_source.h
index 461f653b43..103da90f71 100644
--- a/gr-zeromq/include/gnuradio/zeromq/req_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/req_source.h
@@ -48,7 +48,7 @@ namespace gr {
* \param itemsize Size of a stream item in bytes.
* \param vlen Vector length of the input items. Note that one vector is one item.
* \param address ZMQ socket address specifier.
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
* \param pass_tags Whether source will look for and deserialize tags.
* \param hwm High Watermark to configure the socket to (-1 => zmq's default)
*/
diff --git a/gr-zeromq/include/gnuradio/zeromq/sub_msg_source.h b/gr-zeromq/include/gnuradio/zeromq/sub_msg_source.h
index d06a83c1fd..5c91d1e1ed 100644
--- a/gr-zeromq/include/gnuradio/zeromq/sub_msg_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/sub_msg_source.h
@@ -46,7 +46,7 @@ namespace gr {
* \brief Return a shared_ptr to a new instance of gr::zeromq::sub_msg_source.
*
* \param address ZMQ socket address specifier
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments
*
*/
static sptr make(char *address, int timeout=100);
diff --git a/gr-zeromq/include/gnuradio/zeromq/sub_source.h b/gr-zeromq/include/gnuradio/zeromq/sub_source.h
index def3a703e6..990c74cabd 100644
--- a/gr-zeromq/include/gnuradio/zeromq/sub_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/sub_source.h
@@ -48,7 +48,7 @@ namespace gr {
* \param itemsize Size of a stream item in bytes.
* \param vlen Vector length of the input items. Note that one vector is one item.
* \param address ZMQ socket address specifier.
- * \param timeout Receive timeout in seconds, default is 100ms, 1us increments.
+ * \param timeout Receive timeout in milliseconds, default is 100ms, 1us increments.
* \param pass_tags Whether source will look for and deserialize tags.
* \param hwm High Watermark to configure the socket to (-1 => zmq's default)
*/
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-21 02:32:36 +0000