Difference between revisions of "Socket PDU"

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...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Creates socket interface and translates traffic to PDUs.
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.
+
For server modes, leave Host blank to bind to all interfaces (equivalent to 0.0.0.0).
  
 
== Parameters ==
 
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
  
; Param 1 (''R'')
+
; Type
: 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).
+
: Socket type (TCP/UDP, Client/Server)
  
; Param 2
+
; Host
: blah blah blah
+
: Network address to use
 +
 
 +
; Port
 +
: Network port to use
 +
 
 +
; MTU
 +
: Maximum transmission unit
 +
 
 +
; TCP No delay
 +
: TCP No Delay option (set to True to disable Nagle algorithm)
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 28:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/socket_pdu_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/socket_pdu_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/socket_pdu.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_socket_pdu.block.yml]

Latest revision as of 16:30, 9 March 2020

Creates socket interface and translates traffic to PDUs.

For server modes, leave Host blank to bind to all interfaces (equivalent to 0.0.0.0).

Parameters[edit]

Type
Socket type (TCP/UDP, Client/Server)
Host
Network address to use
Port
Network port to use
MTU
Maximum transmission unit
TCP No delay
TCP No Delay option (set to True to disable Nagle algorithm)

Example Flowgraph[edit]

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[edit]

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]