Loading...
Searching...
No Matches
hdlc_framer_pb.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2014 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_DIGITAL_HDLC_FRAMER_PB_H
#define INCLUDED_DIGITAL_HDLC_FRAMER_PB_H
#include <gnuradio/digital/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace digital {
/*!
* \brief HDLC framer which takes in PMT binary blobs and outputs HDLC
* frames as unpacked bits, with CRC and bit stuffing added. The first sample
* of the frame is tagged with the tag frame_tag_name and includes a
* length field for tagged_stream use.
*
* This block outputs one whole frame at a time; if there is not enough
* output buffer space to fit a frame, it is pushed onto a queue. As a result
* flowgraphs which only run for a finite number of samples may not receive
* all frames in the queue, due to the scheduler's granularity. For
* flowgraphs that stream continuously (anything using a USRP) this should
* not be an issue.
*
* \ingroup pkt_operators_blk
*
*/
class DIGITAL_API hdlc_framer_pb : virtual public gr::sync_block
{
public:
typedef std::shared_ptr<hdlc_framer_pb> sptr;
/*!
* \brief Return a shared_ptr to a new instance of digital::hdlc_framer.
*
* \param frame_tag_name: The tag to add to the first sample of each frame.
*/
static sptr make(const std::string frame_tag_name);
};
} // namespace digital
} // namespace gr
#endif /* INCLUDED_DIGITAL_HDLC_FRAMER_PB_H */
gr::digital::hdlc_framer_pb
HDLC framer which takes in PMT binary blobs and outputs HDLC frames as unpacked bits,...
Definition hdlc_framer_pb.h:37
gr::digital::hdlc_framer_pb::make
static sptr make(const std::string frame_tag_name)
Return a shared_ptr to a new instance of digital::hdlc_framer.
gr::digital::hdlc_framer_pb::sptr
std::shared_ptr< hdlc_framer_pb > sptr
Definition hdlc_framer_pb.h:39
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
api.h
DIGITAL_API
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:18
gr::digital
Definition adaptive_algorithm.h:22
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h