A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::GtpuHeader Class Reference
LTE Models

#include <epc-gtpu-header.h>

+ Inheritance diagram for ns3::GtpuHeader:

Public Member Functions

virtual uint32_t Deserialize (Buffer::Iterator start)
 
bool GetExtensionHeaderFlag () const
 
virtual TypeId GetInstanceTypeId (void) const
 
uint16_t GetLength () const
 
uint8_t GetMessageType () const
 
uint8_t GetNextExtensionType () const
 
uint8_t GetNPduNumber () const
 
bool GetNPduNumberFlag () const
 
bool GetProtocolType () const
 
uint16_t GetSequenceNumber () const
 
bool GetSequenceNumberFlag () const
 
virtual uint32_t GetSerializedSize (void) const
 
uint32_t GetTeid () const
 
uint8_t GetVersion () const
 
bool operator== (const GtpuHeader &b) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetExtensionHeaderFlag (bool m_extensionHeaderFlag)
 
void SetLength (uint16_t m_length)
 
void SetMessageType (uint8_t m_messageType)
 
void SetNextExtensionType (uint8_t m_nextExtensionType)
 
void SetNPduNumber (uint8_t m_nPduNumber)
 
void SetNPduNumberFlag (bool m_nPduNumberFlag)
 
void SetProtocolType (bool m_protocolType)
 
void SetSequenceNumber (uint16_t m_sequenceNumber)
 
void SetSequenceNumberFlag (bool m_sequenceNumberFlag)
 
void SetTeid (uint32_t m_teid)
 
void SetVersion (uint8_t m_version)
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Attributes

bool m_extensionHeaderFlag
 
uint16_t m_length
 
uint8_t m_messageType
 
uint8_t m_nextExtensionType
 
uint8_t m_nPduNumber
 
bool m_nPduNumberFlag
 
bool m_protocolType
 
uint16_t m_sequenceNumber
 
bool m_sequenceNumberFlag
 
uint32_t m_teid
 
uint8_t m_version
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Implementation of the GTPv1-U Release 10 as per 3Gpp TS 29.281 document

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 39 of file epc-gtpu-header.h.

Member Function Documentation

uint32_t ns3::GtpuHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should written.
Returns
the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Implements ns3::Header.

Definition at line 91 of file epc-gtpu-header.cc.

References GetSerializedSize(), m_extensionHeaderFlag, m_length, m_messageType, m_nextExtensionType, m_nPduNumber, m_nPduNumberFlag, m_protocolType, m_sequenceNumber, m_sequenceNumberFlag, m_teid, m_version, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadNtohU32(), and ns3::Buffer::Iterator::ReadU8().

TypeId ns3::GtpuHeader::GetInstanceTypeId ( void  ) const
virtual
Returns
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 65 of file epc-gtpu-header.cc.

uint32_t ns3::GtpuHeader::GetSerializedSize ( void  ) const
virtual
Returns
the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 71 of file epc-gtpu-header.cc.

Referenced by Deserialize(), and ns3::EpcSgwPgwApplication::SendToS1uSocket().

void ns3::GtpuHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 109 of file epc-gtpu-header.cc.

References m_extensionHeaderFlag, m_length, m_messageType, m_nextExtensionType, m_nPduNumber, m_nPduNumberFlag, m_protocolType, m_sequenceNumber, m_sequenceNumberFlag, m_teid, and m_version.

void ns3::GtpuHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 76 of file epc-gtpu-header.cc.

References m_extensionHeaderFlag, m_length, m_messageType, m_nextExtensionType, m_nPduNumber, m_nPduNumberFlag, m_protocolType, m_sequenceNumber, m_sequenceNumberFlag, m_teid, m_version, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteHtonU32(), and ns3::Buffer::Iterator::WriteU8().

Member Data Documentation

bool ns3::GtpuHeader::m_extensionHeaderFlag
private

This flag indicates the presence of a meaningful value of the Next Extension Header field. When it is set to '0', the Next Extension Header field either is not present or, if present, shall not be interpreted. When it is set to '1', the Next Extension Header field is present, and shall be interpreted

Definition at line 95 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint16_t ns3::GtpuHeader::m_length
private

This field indicates the length in octets of the payload, i.e. the rest of the packet following the mandatory part of the GTP header (that is the first 8 octets). The Sequence Number, the N-PDU Number or any Extension headers shall be considered to be part of the payload, i.e. included in the length count

Definition at line 121 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint8_t ns3::GtpuHeader::m_messageType
private

This field indicates the type of GTP-U message

Definition at line 114 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint8_t ns3::GtpuHeader::m_nextExtensionType
private

This field defines the type of Extension Header that follows this field in the GTP-PDU

Definition at line 146 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint8_t ns3::GtpuHeader::m_nPduNumber
private

This field is used at the Inter SGSN Routeing Area Update procedure and some inter-system handover procedures (e.g. between 2G and 3G radio access networks). This field is used to co-ordinate the data transmission for acknowledged mode of communication between the MS and the SGSN

Definition at line 141 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

bool ns3::GtpuHeader::m_nPduNumberFlag
private

This flag indicates the presence of a meaningful value of the N-PDU Number field. When it is set to '0', the N-PDU Number field either is not present, or, if present, shall not be interpreted. When it is set to '1', the N-PDU Number field is present, and shall be interpreted

Definition at line 110 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

bool ns3::GtpuHeader::m_protocolType
private

This bit is used as a protocol discriminator between GTP (when PT is '1') and GTP' (when PT is '0').

Definition at line 87 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint16_t ns3::GtpuHeader::m_sequenceNumber
private

If Sequence Number field is used for G-PDUs (T-PDUs+headers), an increasing sequence number for T-PDUs is transmitted via GTP-U tunnels, when transmission order must be preserved

Definition at line 134 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

bool ns3::GtpuHeader::m_sequenceNumberFlag
private

This flag indicates the presence of a meaningful value of the Sequence Number field. When it is set to '0', the Sequence Number field either is not present or, if present, shall not be interpreted. When it is set to '1', the Sequence Number field is present, and shall be interpreted

Definition at line 103 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint32_t ns3::GtpuHeader::m_teid
private

This field unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use.

Definition at line 128 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

uint8_t ns3::GtpuHeader::m_version
private

This field is used to determine the version of the GTPU-U protocol. The version number shall be set to 1.

Definition at line 81 of file epc-gtpu-header.h.

Referenced by Deserialize(), Print(), and Serialize().

The documentation for this class was generated from the following files: