Difference between revisions of "ZMQ PUB Message Sink"

From GNU Radio
Jump to navigation Jump to search
(add note about IP addresses)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
Sink the contents of a msg port to a ZMQ PUB socket.
The ZMQ PUB Message Sink receives messages from a flowgraph and publishes them on a ZMQ PUB socket. A PUB socket may have many subscribers and will pass all incoming messages to each subscriber. Subscribers can be either a ZMQ SUB Message Source block or a non-GNU Radio ZMQ socket.
 
This block acts a message port receiver and writes individual messages to a ZMQ PUB socket.  
A PUB socket may have subscribers and will pass all incoming messages to each subscriber.  
Subscribers can be either another gr-zeromq source block or a non-GNU Radio ZMQ socket.


== Parameters ==
== Parameters ==
Line 10: Line 6:


; Address
; Address
: ZMQ socket address specifier
: 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, 1us increments
: Socket timeout in milliseconds, default is 100ms.


== Example Flowgraph ==
== Example Flowgraph ==
In this example, a Message Strobe block sends the string "Demo" once per second.


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.
[[File:PUB_SUB_msg_demo.png]]


== Source Files ==
== Source Files ==

Latest revision as of 15:08, 26 March 2020

The ZMQ PUB Message Sink receives messages from a flowgraph and publishes them on a ZMQ PUB socket. A PUB socket may have many subscribers and will pass all incoming messages to each subscriber. Subscribers can be either a ZMQ SUB Message Source block or a non-GNU Radio ZMQ socket.

Parameters[edit]

(R): Run-time adjustable

Address
ZMQ socket address specifier. The format of the address is tcp://*:port where * 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
Socket timeout in milliseconds, default is 100ms.

Example Flowgraph[edit]

In this example, a Message Strobe block sends the string "Demo" once per second.

PUB SUB msg demo.png

Source Files[edit]

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO