This file is indexed.

/usr/include/ns3.27/ns3/ie-dot11s-rann.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
132
133
134
135
136
137
138
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008,2009 IITP RAS
 *
 * 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: Kirill Andreev <andreev@iitp.ru>
 */

#ifndef RANN_INFORMATION_ELEMENT_H
#define RANN_INFORMATION_ELEMENT_H

#include "ns3/mac48-address.h"
#include "ns3/mesh-information-element-vector.h"

namespace ns3 {
namespace dot11s {
/**
 * \ingroup dot11s
 * \brief Root announcement (RANN) element
 */
class IeRann : public WifiInformationElement
{
public:
  IeRann ();
  virtual ~IeRann ();
  /**
   * Set flags field
   * \param flags the flags value to set
   */
  void SetFlags (uint8_t flags);
  /**
   * Set hop count value to number of hops from the originating root mesh
   * STA to the mesh STA transmitting this element
   * \param hopcount the hop count
   */
  void SetHopcount (uint8_t hopcount);
  /**
   * Set TTL value to the remaining number of hops allowed
   * \param ttl the TTL
   */
  void SetTTL (uint8_t ttl);
  /**
   * Set originator address value
   * \param originator_address the originator MAC address
   */
  void SetOriginatorAddress (Mac48Address originator_address);
  /**
   * Set destination sequence number value
   * \param dest_seq_number the destiantion sequence number
   */
  void SetDestSeqNumber (uint32_t dest_seq_number);
  /**
   * Set metric value to cumulative metric from originating root mesh STA
   * to the mesh STA transmitting the announcement
   * \param metric the metric to set
   */
  void SetMetric (uint32_t metric);
  /**
   * Get flags value
   * \returns the flags
   */
  uint8_t GetFlags ();
  /**
   * Get hop count value
   * \returns the hop count
   */
  uint8_t GetHopcount ();
  /**
   * Get TTL value
   * \returns the TTL
   */
  uint8_t GetTtl ();
  /**
   * Get originator address value
   * \returns the MAC address of the originator
   */
  Mac48Address GetOriginatorAddress ();
  /**
   * Get destination sequence number value
   * \returns the destiantion sequence number
   */
  uint32_t GetDestSeqNumber ();
  /**
   * Get metric value
   * \returns the metric
   */
  uint32_t GetMetric ();
  /// Decrement TTL function
  void DecrementTtl ();
  /**
   * Increment metric 
   * \param metric the value to increment
   */
  void IncrementMetric (uint32_t metric);

  // Inherited from WifiInformationElement
  virtual WifiInformationElementId ElementId () const;
  virtual void SerializeInformationField (Buffer::Iterator i) const;
  virtual uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
  virtual uint8_t GetInformationFieldSize () const;
  virtual void Print (std::ostream &os) const;

private:
  uint8_t m_flags; ///< falgs
  uint8_t m_hopcount; ///< hop count
  uint8_t m_ttl; ///< TTL
  Mac48Address m_originatorAddress; ///< originator address
  uint32_t m_destSeqNumber; ///< destination sequence number
  uint32_t m_metric; ///< metric

  /**
   * equality operator
   *
   * \param a lhs
   * \param b rhs
   * \returns true if equal
   */
  friend bool operator== (const IeRann & a, const IeRann & b);
};

bool operator== (const IeRann & a, const IeRann & b);
std::ostream &operator << (std::ostream &os, const IeRann &rann);
} // namespace dot11s
} // namespace ns3

#endif