ZMQ PULL Source: Difference between revisions
Jump to navigation
Jump to search
(clarify address) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
; Address | ; Address | ||
: ZMQ socket address specifier. The format of the address is <code>tcp://*:port</code> where * should be 127.0.0.1 for localhost.<br> | : ZMQ socket address specifier. The format of the address is <code>tcp://*:port</code> where * should be 127.0.0.1 for localhost.<br> | ||
: <b>Note:</b> If the Source and Sink blocks are on two different computers on the same LAN, then the IP and port number of the Sink block must be specified on each end of that connection. For example, if the Sink is on IP 192.168.2.14:5678 and the Source is on IP 192.168.2.5, both Source and Sink blocks must specify the Sink IP and port (192.168.2.14:5678). | |||
; Timeout | ; Timeout | ||
: Receive timeout in milliseconds, default is 100ms. | : Receive timeout in milliseconds, default is 100ms. | ||
| Line 14: | Line 16: | ||
: Whether sink will serialize and pass tags over the link. | : Whether sink will serialize and pass tags over the link. | ||
; High Watermark | ; High Watermark | ||
: High Watermark | : High Watermark is the hard limit on the maximum number of outstanding messages that ZMQ will queue in the memory. The default value is set to -1. If there is to be no limit on the number of messages, set this value to zero. | ||
: <b>Note:</b> ZMQ does not guarantee that the socket will be able to queue as many messages as specified, and the actual limit may be lower or higher, depending on socket transport. | |||
== Example Flowgraph == | == Example Flowgraph == | ||
| Line 23: | Line 26: | ||
; C++ files | ; C++ files | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/main/gr-zeromq/lib/pull_source_impl.cc pull_source_impl.cc] | ||
; Header files | ; Header files | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/main/gr-zeromq/lib/pull_source_impl.h pull_source_impl.h] | ||
; Public header files | ; Public header files | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/main/gr-zeromq/include/gnuradio/zeromq/pull_source.h pull_source.h] | ||
; Block definition | ; Block definition | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/main/gr-zeromq/grc/zeromq_pull_source.block.yml zeromq_pull_source.block.yml] | ||
Latest revision as of 11:11, 3 February 2023
Receive messages on ZMQ PULL socket and source stream.
This block will connect to a ZMQ PUSH socket, then produce all incoming messages as streaming output.
Parameters
(R): Run-time adjustable
- Address
- ZMQ socket address specifier. The format of the address is
tcp://*:portwhere * should be 127.0.0.1 for localhost. - Note: If the Source and Sink blocks are on two different computers on the same LAN, then the IP and port number of the Sink block must be specified on each end of that connection. For example, if the Sink is on IP 192.168.2.14:5678 and the Source is on IP 192.168.2.5, both Source and Sink blocks must specify the Sink IP and port (192.168.2.14:5678).
- Timeout
- Receive timeout in milliseconds, default is 100ms.
- Pass Tags
- Whether sink will serialize and pass tags over the link.
- High Watermark
- High Watermark is the hard limit on the maximum number of outstanding messages that ZMQ will queue in the memory. The default value is set to -1. If there is to be no limit on the number of messages, set this value to zero.
- Note: ZMQ does not guarantee that the socket will be able to queue as many messages as specified, and the actual limit may be lower or higher, depending on socket transport.
Example Flowgraph
Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
Source Files
- C++ files
- pull_source_impl.cc
- Header files
- pull_source_impl.h
- Public header files
- pull_source.h
- Block definition
- zeromq_pull_source.block.yml