Loading...
Searching...
No Matches
protocol_parser_b.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2015-2016 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_DIGITAL_PACKET_PARSE_B_H
#define INCLUDED_DIGITAL_PACKET_PARSE_B_H
#include <gnuradio/digital/api.h>
#include <gnuradio/digital/header_format_base.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace digital {
/*!
* \brief Block that synchronizes to a header based on a header
* format object class. Designed to accept hard bits and produce
* PDUs with packed bytes (pmt::u8vector).
*
* \ingroup packet_operators_blk
*
* \details
*
* A packet synchronizer block. This block takes in hard bits
* (unpacked bytes; 1's and 0's as the LSB) and finds the access
* code as a sync word to find the start of a frame.
*
* The block uses a format object derived from a
* header_format_base class.
*
* Once the frame is detected (usually through the use of an
* access code), the block uses the format object's parser
* function to decode the remaining header. Generally, as in the
* default header case, the header will contain the length of the
* frame's payload. That and anything else in the header will
* generally go into the PDU's meta-data dictionary.
*
* The block will output a PDU that contains frame's header info
* in the meta-data portion of the PDU and the payload itself. The
* payload is packed hard bits as taken from the input stream.
*
* \sa packet_sync_ff for a soft decision version.
*/
class DIGITAL_API protocol_parser_b : virtual public sync_block
{
public:
typedef std::shared_ptr<protocol_parser_b> sptr;
/*!
* Make a packet header block using a given \p format.
*
* \param format The format object to use when reading the
* header.
*/
static sptr make(const header_format_base::sptr& format);
};
} // namespace digital
} // namespace gr
#endif /* INCLUDED_DIGITAL_PROTOCOL_PARSER_B_H */
gr::digital::header_format_base::sptr
std::shared_ptr< header_format_base > sptr
Definition header_format_base.h:114
gr::digital::protocol_parser_b
Block that synchronizes to a header based on a header format object class. Designed to accept hard bi...
Definition protocol_parser_b.h:52
gr::digital::protocol_parser_b::sptr
std::shared_ptr< protocol_parser_b > sptr
Definition protocol_parser_b.h:54
gr::digital::protocol_parser_b::make
static sptr make(const header_format_base::sptr &format)
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
DIGITAL_API
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:18
header_format_base.h
gr::digital
Definition adaptive_algorithm.h:22
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h