Packet Header Generator: Difference between revisions
Jump to navigation
Jump to search
(Typo) |
No edit summary |
||
| Line 2: | Line 2: | ||
Generates a header for a tagged, streamed packet. | Generates a header for a tagged, streamed packet. | ||
Input: A tagged stream. This is consumed entirely, it is not appended to the output stream. | Input: A tagged stream of bytes. This is consumed entirely, it is not appended to the output stream. | ||
Output: A tagged stream containing the header. The details on the header are set in a header formatter object (of type packet_header_default or a subclass thereof). | Output: A tagged stream containing the header. The details on the header are set in a header formatter object (of type packet_header_default or a subclass thereof). To use a default header, see packet_header_default. | ||
== Parameters == | == Parameters == | ||
; | ; Formatter Object | ||
: | : A header formatter object. | ||
; Length Tag Name | ; Length Tag Name | ||
: Length Tag Key | : Length Tag Key. Note that it is irrelevant which tag names are set in the formatter object. Only this value is relevant. | ||
== Example Flowgraph == | == Example Flowgraph == | ||
| Line 20: | Line 20: | ||
; C++ files | ; C++ files | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/packet_headergenerator_bb_impl.cc] | ||
; Header files | ; Header files | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/packet_headergenerator_bb_impl.h] | ||
; Public header files | ; Public header files | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/include/gnuradio/digital/packet_headergenerator_bb.h] | ||
; Block definition | ; Block definition | ||
: [https://github.com/gnuradio/gnuradio | : [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/grc/digital_packet_headergenerator_bb_default.block.yml] | ||
Revision as of 13:41, 8 August 2023
Generates a header for a tagged, streamed packet.
Input: A tagged stream of bytes. This is consumed entirely, it is not appended to the output stream.
Output: A tagged stream containing the header. The details on the header are set in a header formatter object (of type packet_header_default or a subclass thereof). To use a default header, see packet_header_default.
Parameters
- Formatter Object
- A header formatter object.
- Length Tag Name
- Length Tag Key. Note that it is irrelevant which tag names are set in the formatter object. Only this value is relevant.
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
- [1]
- Header files
- [2]
- Public header files
- [3]
- Block definition
- [4]