A Discrete-Event Network Simulator
API
lte-rlc-header.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Manuel Requena <manuel.requena@cttc.es>
19  */
20 
21 #ifndef LTE_RLC_HEADER_H
22 #define LTE_RLC_HEADER_H
23 
24 #include "ns3/header.h"
25 #include "ns3/lte-rlc-sequence-number.h"
26 
27 #include <list>
28 
29 namespace ns3 {
30 
39 class LteRlcHeader : public Header
40 {
41 public:
42 
48  LteRlcHeader ();
49  ~LteRlcHeader ();
50 
56  void SetFramingInfo (uint8_t framingInfo);
62  void SetSequenceNumber (SequenceNumber10 sequenceNumber);
63 
69  uint8_t GetFramingInfo () const;
76 
82  void PushExtensionBit (uint8_t extensionBit);
88  void PushLengthIndicator (uint16_t lengthIndicator);
89 
95  uint8_t PopExtensionBit (void);
101  uint16_t PopLengthIndicator (void);
102 
104  typedef enum {
108 
110  typedef enum {
111  FIRST_BYTE = 0x00,
112  NO_FIRST_BYTE = 0x02
114 
116  typedef enum {
117  LAST_BYTE = 0x00,
118  NO_LAST_BYTE = 0x01
120 
121 
126  static TypeId GetTypeId (void);
127  virtual TypeId GetInstanceTypeId (void) const;
128  virtual void Print (std::ostream &os) const;
129  virtual uint32_t GetSerializedSize (void) const;
130  virtual void Serialize (Buffer::Iterator start) const;
131  virtual uint32_t Deserialize (Buffer::Iterator start);
132 
133 private:
134  uint16_t m_headerLength;
135  uint8_t m_framingInfo;
137 
138  std::list <uint8_t> m_extensionBits;
139  std::list <uint16_t> m_lengthIndicators;
140 
141 };
142 
143 }; // namespace ns3
144 
145 #endif // LTE_RLC_HEADER_H
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::LteRlcHeader::NO_FIRST_BYTE
@ NO_FIRST_BYTE
Definition: lte-rlc-header.h:112
ns3::LteRlcHeader::PopExtensionBit
uint8_t PopExtensionBit(void)
Pop extension bit.
Definition: lte-rlc-header.cc:96
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::LteRlcHeader::NO_LAST_BYTE
@ NO_LAST_BYTE
Definition: lte-rlc-header.h:118
ns3::LteRlcHeader::GetInstanceTypeId
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: lte-rlc-header.cc:126
ns3::LteRlcHeader::PopLengthIndicator
uint16_t PopLengthIndicator(void)
Pop length indicator.
Definition: lte-rlc-header.cc:105
ns3::LteRlcHeader::Print
virtual void Print(std::ostream &os) const
Definition: lte-rlc-header.cc:131
ns3::LteRlcHeader::DATA_FIELD_FOLLOWS
@ DATA_FIELD_FOLLOWS
Definition: lte-rlc-header.h:105
ns3::LteRlcHeader::GetSequenceNumber
SequenceNumber10 GetSequenceNumber() const
Get sequence number.
Definition: lte-rlc-header.cc:64
ns3::LteRlcHeader
The packet header for the Radio Link Control (RLC) protocol packets.
Definition: lte-rlc-header.h:40
ns3::LteRlcHeader::m_framingInfo
uint8_t m_framingInfo
2 bits
Definition: lte-rlc-header.h:135
ns3::LteRlcHeader::GetSerializedSize
virtual uint32_t GetSerializedSize(void) const
Definition: lte-rlc-header.cc:163
ns3::LteRlcHeader::m_headerLength
uint16_t m_headerLength
header length
Definition: lte-rlc-header.h:134
visualizer.core.start
def start()
Definition: core.py:1855
ns3::LteRlcHeader::FIRST_BYTE
@ FIRST_BYTE
Definition: lte-rlc-header.h:111
ns3::LteRlcHeader::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: lte-rlc-header.cc:115
ns3::Header
Protocol header serialization and deserialization.
Definition: header.h:43
ns3::LteRlcHeader::E_LI_FIELDS_FOLLOWS
@ E_LI_FIELDS_FOLLOWS
Definition: lte-rlc-header.h:106
ns3::LteRlcHeader::Serialize
virtual void Serialize(Buffer::Iterator start) const
Definition: lte-rlc-header.cc:168
ns3::LteRlcHeader::ExtensionBit_t
ExtensionBit_t
ExtensionBit_t typedef.
Definition: lte-rlc-header.h:104
ns3::LteRlcHeader::FramingInfoLastByte_t
FramingInfoLastByte_t
FramingInfoLastByte_t tyedef.
Definition: lte-rlc-header.h:116
ns3::Header::Deserialize
virtual uint32_t Deserialize(Buffer::Iterator start)=0
Deserialize the object from a buffer iterator.
ns3::Buffer::Iterator
iterator in a Buffer instance
Definition: buffer.h:99
ns3::LteRlcHeader::SetSequenceNumber
void SetSequenceNumber(SequenceNumber10 sequenceNumber)
Set sequence number.
Definition: lte-rlc-header.cc:52
ns3::LteRlcHeader::~LteRlcHeader
~LteRlcHeader()
Definition: lte-rlc-header.cc:38
ns3::LteRlcHeader::SetFramingInfo
void SetFramingInfo(uint8_t framingInfo)
Set framing info.
Definition: lte-rlc-header.cc:46
ns3::LteRlcHeader::PushExtensionBit
void PushExtensionBit(uint8_t extensionBit)
Push extension bit.
Definition: lte-rlc-header.cc:71
ns3::LteRlcHeader::PushLengthIndicator
void PushLengthIndicator(uint16_t lengthIndicator)
Push length indicator.
Definition: lte-rlc-header.cc:89
ns3::LteRlcHeader::m_lengthIndicators
std::list< uint16_t > m_lengthIndicators
length indicators
Definition: lte-rlc-header.h:139
ns3::LteRlcHeader::LAST_BYTE
@ LAST_BYTE
Definition: lte-rlc-header.h:117
ns3::LteRlcHeader::m_sequenceNumber
SequenceNumber10 m_sequenceNumber
sequence number
Definition: lte-rlc-header.h:136
ns3::SequenceNumber10
SequenceNumber10 class.
Definition: lte-rlc-sequence-number.h:37
ns3::LteRlcHeader::GetFramingInfo
uint8_t GetFramingInfo() const
Get framing info.
Definition: lte-rlc-header.cc:58
ns3::LteRlcHeader::m_extensionBits
std::list< uint8_t > m_extensionBits
Includes extensionBit of the fixed part.
Definition: lte-rlc-header.h:138
ns3::LteRlcHeader::FramingInfoFirstByte_t
FramingInfoFirstByte_t
FramingInfoFirstByte_t typedef.
Definition: lte-rlc-header.h:110
ns3::LteRlcHeader::LteRlcHeader
LteRlcHeader()
Constructor.
Definition: lte-rlc-header.cc:31