Difference between revisions of "UDP Sink"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Write stream to an UDP socket.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
== Parameters ==
 +
; IP Address
 +
: The name or IP address of the transmitting host; can be NULL, None, or "0.0.0.0" to allow reading from any interface on the host
  
== Parameters ==
+
; Port
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
+
: The port number on which to receive data; use 0 to have the system assign an unused port number
  
; Param 1 (''R'')
+
; Payload Size
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
: UDP payload size by default set to 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
  
; Param 2
+
; Null Packet is EOF
: blah blah blah
+
: Interpret zero-length packet as EOF (default: true)
  
 
== Example Flowgraph ==
 
== 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 ==
 
== Source Files ==

Revision as of 21:33, 2 September 2019

Write stream to an UDP socket.

Parameters

IP Address
The name or IP address of the transmitting host; can be NULL, None, or "0.0.0.0" to allow reading from any interface on the host
Port
The port number on which to receive data; use 0 to have the system assign an unused port number
Payload Size
UDP payload size by default set to 1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP header))
Null Packet is EOF
Interpret zero-length packet as EOF (default: true)

Example Flowgraph

Source Files

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