/usr/include/ns3.27/ns3/lr-wpan-mac-trailer.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 The Boeing Company
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author:
* kwong yin <kwong-sang.yin@boeing.com>
* Sascha Alexander Jopen <jopen@cs.uni-bonn.de>
* Erwan Livolant <erwan.livolant@inria.fr>
*/
#ifndef LR_WPAN_MAC_TRAILER_H
#define LR_WPAN_MAC_TRAILER_H
#include <ns3/trailer.h>
namespace ns3 {
class Packet;
/**
* \ingroup lr-wpan
*
* Represent the Mac Trailer with the Frame Check Sequence field.
*/
class LrWpanMacTrailer : public Trailer
{
public:
/**
* The length in octets of the IEEE 802.15.4 MAC FCS field
*/
static const uint16_t LR_WPAN_MAC_FCS_LENGTH;
/**
* Get the type ID.
*
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* Default constructor for a MAC trailer with disabled FCS calculation.
*/
LrWpanMacTrailer (void);
// Inherited from the Trailer class.
virtual TypeId GetInstanceTypeId (void) const;
virtual void Print (std::ostream &os) const;
virtual uint32_t GetSerializedSize (void) const;
virtual void Serialize (Buffer::Iterator start) const;
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* Get this trailers FCS value. If FCS calculation is disabled for this
* trailer, the returned value is always 0.
*
* \return the FCS value.
*/
uint16_t GetFcs (void) const;
/**
* Calculate and set the FCS value based on the given packet.
*
* \param p the packet for which the FCS should be calculated
*/
void SetFcs (Ptr<const Packet> p);
/**
* Check the FCS of a given packet against the FCS value stored in the
* trailer. The packet itself should contain no trailer. If FCS calculation is
* disabled for this trailer, CheckFcs() will always return true.
*
* \param p the packet to be checked
* \return false, if the FCS values do not match, true otherwise
*/
bool CheckFcs (Ptr<const Packet> p);
/**
* Enable or disable FCS calculation for this trailer.
*
* \param enable flag, indicating if FCS calculation should be enabled or not
*/
void EnableFcs (bool enable);
/**
* Query if FCS calculation is enabled for this trailer.
*
* \return true, if FCS calculation is enabled, false otherwise.
*/
bool IsFcsEnabled (void);
private:
/**
* Calculate the 16-bit FCS value.
* CRC16-CCITT with a generator polynomial = ^16 + ^12 + ^5 + 1, LSB first and
* initial value = 0x0000.
*
* \param data the checksum will be calculated over this data
* \param length the length of the data
* \return the checksum
*/
uint16_t GenerateCrc16 (uint8_t *data, int length);
/**
* The FCS value stored in this trailer.
*/
uint16_t m_fcs;
/**
* Only if m_calcFcs is true, FCS values will be calculated and used in the
* trailer
*/
bool m_calcFcs;
};
} // namespace ns3
#endif /* LR_WPAN_MAC_TRAILER_H */
|