This file is indexed.

/usr/include/ns3/radio-bearer-instance.h is in libns3-dev 3.13+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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
 *
 * 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: Giuseppe Piro  <g.piro@poliba.it>
 */

#ifndef RADIO_BEARER_INSTANCE_H
#define RADIO_BEARER_INSTANCE_H

#include "ns3/object.h"
#include "lte-mac-queue.h"
#include "ns3/ipcs-classifier-record.h"

namespace ns3 {

class BearerQosParameters;
class RlcEntity;

/**
 * \ingroup lte
 *
 * This class implements the LTE radio bearer in which
 * a data flow between UE and eNB will be mapped.
 */
class RadioBearerInstance : public Object
{
public:
  static TypeId GetTypeId (void);

  RadioBearerInstance (void);
  virtual ~RadioBearerInstance (void);

  /**
   * The direction of the bearer
   */
  enum BearerDirection
  {
    DIRECTION_TYPE_UL, DIRECTION_TYPE_DL
  };

  /**
   * The bearer type
   */
  enum BearerType
  {
    /*
     As the mobile device is already known in the core network
     the following radio bearers are now established automatically:
     - A low priority signaling (message) bearer (SRB1)
     - A high priority signaling (message) bearer (SRB2)
     - A data radio bearer (DRB), i.e. a bearer for IP packets
     */
    BEARER_TYPE_SRB1, BEARER_TYPE_SRB2, BEARER_TYPE_DRB
  };

  /**
   * \brief Set direction of the bearer
   * \param direction the direction of the bearer
   */
  void SetBearerDirection (BearerDirection direction);
  /**
   * \brief Get direction of the bearer
   * \return the direction of the bearer
   */
  BearerDirection GetBearerDirection (void) const;

  /**
   * \brief Set the type of bearer
   * \param type the QoS type
   */
  void SetBearerType (BearerType type);
  /**
   * \brief Get the type of bearer
   * \return the type the bearer
   */
  BearerType GetBearerType (void) const;

  /**
   * \return the queue of the bearer
   */
  Ptr<LteMacQueue> GetQueue (void) const;


  /**
   * \brief enqueue a packet in the queue of the bearer
   * \param packet the packet to be enqueued
   */
  bool Enqueue (Ptr<Packet> packet);

  /**
   * \brief dequeue a packet from the queue of the bearer
   */
  Ptr<Packet> Dequeue (void);

  /**
   * \brief dequeue a packet from the queue of the bearer
   * \param availableByte number of bytes can be dequeued
   */
  Ptr<Packet> Dequeue (uint32_t availableByte);

  /**
   * \return true if the bearer has at least one packet in its queue, false otherwise
   */
  bool HasPackets (void) const;

  /**
   * \brief Set a list of QoS parameters of the Bearer
   * \param qosParameters the list of QoS parameters
   */
  void SetQosParameters (Ptr<BearerQosParameters> qosParameters);
  /**
   * \brief Get a list of QoS parameters of the Bearer
   * \return the pointer to the list of QoS parameters
   */
  Ptr<BearerQosParameters> GetQosParameters (void);

  /**
   * \brief Set the RLC entity of this bearer
   * \param rlc the RLC entity
   */
  void SetRlcEntity (Ptr<RlcEntity> rlc);
  /**
   * \brief Get the RLC entity if this bearer
   * \return the pointer to the RLC entity
   */
  Ptr<RlcEntity> GetRlcEntity (void);

  /**
   * \brief Set the ip classifier record
   * \param c the pointer to the ip classifier record
   */
  void SetIpcsClassifierRecord (IpcsClassifierRecord* c);

  /**
   * \brief Get the ip classifier record
   * \return the pointer to the ip classifier record
   */
  IpcsClassifierRecord* GetIpcsClassifierRecord (void);

private:
  virtual void DoDispose (void);

  Ptr<LteMacQueue> m_queue;

  Ptr<BearerQosParameters> m_qosParameters;

  BearerDirection m_direction;
  BearerType m_bearerType;

  Ptr<RlcEntity> m_rlcEntity;

  IpcsClassifierRecord* m_ipcsClassifierRecord;
};


} // namespace ns3

#endif /* RADIO_BEARER_INSTANCE_H */