GNU Radio 3.7.0-50 C++ API
gr::digital::packet_headerparser_b Class Reference

Post header metadata as a PMT. More...

#include <packet_headerparser_b.h>

Inheritance diagram for gr::digital::packet_headerparser_b:
gr::sync_block gr::block gr::basic_block gr::msg_accepter gr::messages::msg_accepter

Public Types

typedef boost::shared_ptr
< packet_headerparser_b
sptr

Static Public Member Functions

static sptr make (const gr::digital::packet_header_default::sptr &header_formatter)
static sptr make (long header_len, const std::string &len_tag_key)

Additional Inherited Members

- Public Member Functions inherited from gr::sync_block
virtual int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
 just like gr::block::general_work, only this arranges to call consume_each for you
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items
int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
- Protected Member Functions inherited from gr::sync_block
 sync_block (void)
 sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
- Protected Attributes inherited from gr::block
std::vector< long > d_max_output_buffer
std::vector< long > d_min_output_buffer
gr::thread::mutex d_setlock
gr::logger_ptr d_logger
gr::logger_ptr d_debug_logger

Detailed Description

Post header metadata as a PMT.

In a sense, this is the inverse block to packet_headergenerator_bb. The difference is, the parsed header is not output as a stream, but as a PMT dictionary, which is published to message port with the id "header_data".

The dictionary consists of the tags created by the header formatter object. You should be able to use the exact same formatter object as used on the Tx side in the packet_headergenerator_bb.

If only a header length is given, this block uses the default header format.

Member Typedef Documentation

Member Function Documentation

static sptr gr::digital::packet_headerparser_b::make ( const gr::digital::packet_header_default::sptr header_formatter)
static
Parameters
header_formatterHeader object. This should be the same as used for packet_headergenerator_bb.
static sptr gr::digital::packet_headerparser_b::make ( long  header_len,
const std::string &  len_tag_key 
)
static
Parameters
header_lenNumber of bytes per header
len_tag_keyLength Tag Key

The documentation for this class was generated from the following file: