Loading...
Searching...
No Matches
protocol_formatter_async.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_PROTOCOL_FORMATTER_ASYNC_H
#define INCLUDED_DIGITAL_PROTOCOL_FORMATTER_ASYNC_H
#include <gnuradio/block.h>
#include <gnuradio/digital/api.h>
#include <gnuradio/digital/header_format_base.h>
namespace gr {
namespace digital {
/*!
* \brief Uses a header format object to append a header onto a
* PDU.
*
* \ingroup packet_operators_blk
*
* \details
* This block takes in PDUs and creates a header, generally for
* MAC-level processing. Each received PDU is assumed to be its
* own frame, so any fragmentation would be done upstream in or
* before the flowgraph.
*
* The header that is created and transmitted out of the 'header'
* message port as a PDU. The header is based entirely on the \p
* format object, which is an object derived from the
* header_format_base class. All of these packet header format
* objects operate the same: they take in the payload data as well
* as possible extra metadata info about the PDU; the format
* object then returns the output PDU as a PMT argument along
* with any changes to the metadata info PMT.
*
* For different packet header formatting needs, we can define new
* classes that inherit from the header_format_base block
* and which overload the header_format_base::format
* function.
*
* \sa header_format_base
* \sa header_format_default
* \sa header_format_counter
*
* This block only uses asynchronous message passing interfaces to
* receiver and emit PDUs. The message ports are:
*
* \li in: receives PDUs for the frame payload
* \li header: the header formatted for the given frame
* \li payload: the payload
*/
class DIGITAL_API protocol_formatter_async : virtual public block
{
public:
typedef std::shared_ptr<protocol_formatter_async> sptr;
/*!
* Make a packet header block using a given \p format.
*
* \param format The format object to use when creating the
* header for the packet.
*/
static sptr make(const header_format_base::sptr& format);
};
} // namespace digital
} // namespace gr
#endif /* INCLUDED_DIGITAL_PROTOCOL_FORMATTER_ASYNC_H */
gr::block::block
block(void)
Definition gnuradio-runtime/include/gnuradio/block.h:806
gr::digital::header_format_base::sptr
std::shared_ptr< header_format_base > sptr
Definition header_format_base.h:114
gr::digital::protocol_formatter_async
Uses a header format object to append a header onto a PDU.
Definition protocol_formatter_async.h:60
gr::digital::protocol_formatter_async::make
static sptr make(const header_format_base::sptr &format)
gr::digital::protocol_formatter_async::sptr
std::shared_ptr< protocol_formatter_async > sptr
Definition protocol_formatter_async.h:62
block.h
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