GNU Radio Manual and C++ API Reference 3.9.4.0
The Free & Open Software Radio Ecosystem
simple_framer.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2012 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_GR_SIMPLE_FRAMER_H
12#define INCLUDED_GR_SIMPLE_FRAMER_H
13
14#include <gnuradio/block.h>
16
17namespace gr {
18namespace digital {
19
20/*!
21 * \brief add sync field, seq number and command field to payload
22 * \ingroup packet_operators_blk
23 * \ingroup deprecated_blk
24 *
25 * \details
26 * Takes in enough samples to create a full output frame. The
27 * frame is prepended with the GRSF_SYNC (defined in
28 * simple_framer_sync.h) and an 8-bit sequence number.
29 */
30class DIGITAL_API simple_framer : virtual public block
31{
32public:
33 // gr::digital::simple_framer::sptr
34 typedef std::shared_ptr<simple_framer> sptr;
35
36 /*!
37 * Make a simple_framer block.
38 *
39 * \param payload_bytesize The size of the payload in bytes.
40 */
41 static sptr make(int payload_bytesize);
42};
43
44} /* namespace digital */
45} /* namespace gr */
46
47#endif /* INCLUDED_GR_SIMPLE_FRAMER_H */
The abstract base class for all 'terminal' processing blocks.
Definition: gnuradio-runtime/include/gnuradio/block.h:60
add sync field, seq number and command field to payload
Definition: simple_framer.h:31
static sptr make(int payload_bytesize)
std::shared_ptr< simple_framer > sptr
Definition: simple_framer.h:34
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:18
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:29