GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
crc32.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2011,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_DIGITAL_CRC32_H
24 #define INCLUDED_DIGITAL_CRC32_H
25 
26 #include <gnuradio/digital/api.h>
27 #include <string>
28 #include <gnuradio/types.h>
29 
30 namespace gr {
31  namespace digital {
32 
33  /*!
34  * \brief update running CRC-32
35  * \ingroup packet_operators_blk
36  *
37  * \details
38  * Update a running CRC with the bytes buf[0..len-1] The CRC
39  * should be initialized to all 1's, and the transmitted value is
40  * the 1's complement of the final running CRC. The resulting CRC
41  * should be transmitted in big endian order.
42  */
43  DIGITAL_API unsigned int
44  update_crc32(unsigned int crc, const unsigned char *buf, size_t len);
45 
46  DIGITAL_API unsigned int
47  update_crc32(unsigned int crc, const std::string buf);
48 
49  DIGITAL_API unsigned int
50  crc32(const unsigned char *buf, size_t len);
51 
52  DIGITAL_API unsigned int
53  crc32(const std::string buf);
54 
55  } /* namespace digital */
56 } /* namespace gr */
57 
58 #endif /* INCLUDED_CRC32_H */
DIGITAL_API unsigned int crc32(const unsigned char *buf, size_t len)
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: logger.h:131
DIGITAL_API unsigned int update_crc32(unsigned int crc, const unsigned char *buf, size_t len)
update running CRC-32