Message Debug: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(add section for version 3.9; revised format)
Line 1: Line 1:
[[Category:Block Docs]]
<span data-vad="gr_vad"></span>
Debug block for the message passing system.
Debug block for the message passing system.


The message debug block is used to capture and print or store messages as they are received. Any block that generates a message may connect that message port to one or more of the three message input ports of this debug block.
The message debug block is used to capture and print or store messages as they are received. Any block that generates a message may connect that message port to one or more of the three message input ports of this debug block.


The message ports are:
== Parameters ==
 
; None


* print: prints the message directly to standard out.
== Messages ==
* store: stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
* print_pdu: specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).


== Parameters ==
=== Inputs ===
<div data-vad="3.8">
==== Applies to Version 3.8 ====
----
; print
: Prints the message to standard out.
; store
: Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
; print_pdu
: Specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).
</div>


None
<div data-vad="3.9">
==== Applies to Version 3.9 ====
----
; print
: Prints all messages to standard out. They can be either PMT or PDU messages.
; store
: Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
; print_pdu
: PDU messages are redirected to the 'print' port
</div>


== Example Flowgraph ==
== Example Flowgraph ==
Line 32: Line 51:
; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_message_debug.block.yml]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_message_debug.block.yml]
[[Category:Block Docs]]

Revision as of 17:43, 5 December 2022

Debug block for the message passing system.

The message debug block is used to capture and print or store messages as they are received. Any block that generates a message may connect that message port to one or more of the three message input ports of this debug block.

Parameters

None

Messages

Inputs

Applies to Version 3.8


print
Prints the message to standard out.
store
Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
print_pdu
Specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).

Applies to Version 3.9


print
Prints all messages to standard out. They can be either PMT or PDU messages.
store
Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
print_pdu
PDU messages are redirected to the 'print' port

Example Flowgraph

In this example, a Message Strobe block sends the string "Demo" once per second. It is displayed on the user terminal by the Message Debug block.

PUB SUB msg demo.png

Source Files

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