GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
framer_sink_1.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2005,2006,2012 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_FRAMER_SINK_1_H
24#define INCLUDED_GR_FRAMER_SINK_1_H
25
27#include <gnuradio/msg_queue.h>
28#include <gnuradio/sync_block.h>
29
30namespace gr {
31namespace digital {
32
33/*!
34 * \brief Given a stream of bits and access_code flags, assemble packets.
35 * \ingroup packet_operators_blk
36 *
37 * \details
38 * input: stream of bytes from digital_correlate_access_code_bb
39 * output: none. Pushes assembled packet into target queue
40 *
41 * The framer expects a fixed length header of 2 16-bit shorts
42 * containing the payload length, followed by the payload. If the
43 * 2 16-bit shorts are not identical, this packet is
44 * ignored. Better algs are welcome.
45 *
46 * The input data consists of bytes that have two bits used. Bit
47 * 0, the LSB, contains the data bit. Bit 1 if set, indicates that
48 * the corresponding bit is the the first bit of the packet. That
49 * is, this bit is the first one after the access code.
50 */
51class DIGITAL_API framer_sink_1 : virtual public sync_block
52{
53public:
54 // gr::digital::framer_sink_1::sptr
55 typedef boost::shared_ptr<framer_sink_1> sptr;
56
57 /*!
58 * Make a framer_sink_1 block.
59 *
60 * \param target_queue The message queue where frames go.
61 */
62 static sptr make(msg_queue::sptr target_queue);
63};
64
65} /* namespace digital */
66} /* namespace gr */
67
68#endif /* INCLUDED_GR_FRAMER_SINK_1_H */
Given a stream of bits and access_code flags, assemble packets.
Definition framer_sink_1.h:52
static sptr make(msg_queue::sptr target_queue)
boost::shared_ptr< framer_sink_1 > sptr
Definition framer_sink_1.h:55
boost::shared_ptr< msg_queue > sptr
Definition msg_queue.h:47
synchronous 1:1 input to output with history
Definition sync_block.h:38
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46