A Discrete-Event Network Simulator
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
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: Jaume Nin <jnin@cttc.cat>
19  */
22 #ifndef EPS_GTPU_V1_H
23 #define EPS_GTPU_V1_H
25 #include <ns3/ptr.h>
26 #include <ns3/header.h>
27 #include <ns3/ipv4-header.h>
29 namespace ns3 {
31 class Packet;
41 class GtpuHeader : public Header
42 {
43 public:
48  static TypeId GetTypeId (void);
49  GtpuHeader ();
50  virtual ~GtpuHeader ();
51  virtual TypeId GetInstanceTypeId (void) const;
52  virtual uint32_t GetSerializedSize (void) const;
53  virtual void Serialize (Buffer::Iterator start) const;
54  virtual uint32_t Deserialize (Buffer::Iterator start);
55  virtual void Print (std::ostream &os) const;
61  bool GetExtensionHeaderFlag () const;
66  uint16_t GetLength () const;
71  uint8_t GetMessageType () const;
76  uint8_t GetNPduNumber () const;
81  bool GetNPduNumberFlag () const;
86  uint8_t GetNextExtensionType () const;
91  bool GetProtocolType () const;
96  uint16_t GetSequenceNumber () const;
101  bool GetSequenceNumberFlag () const;
106  uint32_t GetTeid () const;
111  uint8_t GetVersion () const;
116  void SetExtensionHeaderFlag (bool extensionHeaderFlag);
121  void SetLength (uint16_t length);
126  void SetMessageType (uint8_t messageType);
131  void SetNPduNumber (uint8_t nPduNumber);
136  void SetNPduNumberFlag (bool nPduNumberFlag);
141  void SetNextExtensionType (uint8_t nextExtensionType);
146  void SetProtocolType (bool protocolType);
151  void SetSequenceNumber (uint16_t sequenceNumber);
156  void SetSequenceNumberFlag (bool sequenceNumberFlag);
161  void SetTeid (uint32_t teid);
166  void SetVersion (uint8_t version);
174  bool operator == (const GtpuHeader& b) const;
177 private:
181  uint8_t m_version; // really a 3 uint3_t
214  uint8_t m_messageType;
221  uint16_t m_length;
228  uint32_t m_teid;
241  uint8_t m_nPduNumber;
248 };
250 } // namespace ns3
252 #endif /* EPS_GTPU_V1_H */
Protocol header serialization and deserialization.
Definition: header.h:42
void SetNextExtensionType(uint8_t nextExtensionType)
Set next extension type function.
uint16_t GetSequenceNumber() const
Get protocol type function.
bool m_nPduNumberFlag
This flag indicates the presence of a meaningful value of the N-PDU Number field. ...
void SetSequenceNumber(uint16_t sequenceNumber)
Set sequence number function.
void SetVersion(uint8_t version)
Set version function.
string version
Definition: conf.py:51
def start()
Definition: core.py:1790
void SetLength(uint16_t length)
Set the length in octets of the payload.
void SetProtocolType(bool protocolType)
Set protocol type function.
virtual void Serialize(Buffer::Iterator start) const
uint8_t m_nPduNumber
This field is used at the Inter SGSN Routeing Area Update procedure and some inter-system handover pr...
uint8_t GetMessageType() const
Get message type function.
void SetNPduNumber(uint8_t nPduNumber)
Set NPDU number function.
bool m_protocolType
This bit is used as a protocol discriminator between GTP (when PT is '1') and GTP' (when PT is '0')...
iterator in a Buffer instance
Definition: buffer.h:98
virtual uint32_t GetSerializedSize(void) const
uint8_t m_messageType
This field indicates the type of GTP-U message.
void SetExtensionHeaderFlag(bool extensionHeaderFlag)
Set extension header flag function.
bool GetNPduNumberFlag() const
Get type of GTP-U message function.
virtual void Print(std::ostream &os) const
void SetNPduNumberFlag(bool nPduNumberFlag)
Sets the flag that indicates the presence of a meaningful value of the N-PDU Number field...
uint16_t m_sequenceNumber
If Sequence Number field is used for G-PDUs (T-PDUs+headers), an increasing sequence number for T-PDU...
bool m_extensionHeaderFlag
This flag indicates the presence of a meaningful value of the Next Extension Header field...
uint8_t m_version
This field is used to determine the version of the GTPU-U protocol.
bool GetProtocolType() const
Get protocol type function.
void SetMessageType(uint8_t messageType)
Set message type function.
uint8_t m_nextExtensionType
This field defines the type of Extension Header that follows this field in the GTP-PDU.
bool GetExtensionHeaderFlag() const
Get extension header flag function.
bool GetSequenceNumberFlag() const
Get sequence number flag function.
virtual ~GtpuHeader()
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint8_t GetVersion() const
Get version function.
bool m_sequenceNumberFlag
This flag indicates the presence of a meaningful value of the Sequence Number field.
uint32_t GetTeid() const
Get a tunnel endpoint identificator (TEID)
uint16_t m_length
This field indicates the length in octets of the payload, i.e.
static TypeId GetTypeId(void)
Get the type ID.
bool operator==(const GtpuHeader &b) const
Equality operator.
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
void SetTeid(uint32_t teid)
Set TEID function.
uint8_t GetNPduNumber() const
Get NPDU number function.
uint8_t GetNextExtensionType() const
Get next extension type function.
uint16_t GetLength() const
Get length function.
virtual uint32_t Deserialize(Buffer::Iterator start)
void SetSequenceNumberFlag(bool sequenceNumberFlag)
Set sequence number flag function.
uint32_t m_teid
This field unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity...
a unique identifier for an interface.
Definition: type-id.h:58
Implementation of the GPRS Tunnelling Protocol header according to GTPv1-U Release 10 as per 3Gpp TS ...