5G-LENA nr-v3.3-120-gdac69c56
The 5G/NR module for the ns-3 simulator
Loading...
Searching...
No Matches
ns3::NrGtpuHeader Class Reference

#include "nr-epc-gtpu-header.h"

+ Inheritance diagram for ns3::NrGtpuHeader:
+ Collaboration diagram for ns3::NrGtpuHeader:

Public Member Functions

uint32_t Deserialize (Buffer::Iterator start) override
 
bool GetExtensionHeaderFlag () const
 
TypeId GetInstanceTypeId () const override
 
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
 
uint32_t GetSerializedSize () const override
 
uint32_t GetTeid () const
 
uint8_t GetVersion () const
 
bool operator== (const NrGtpuHeader &b) const
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
void SetExtensionHeaderFlag (bool extensionHeaderFlag)
 
void SetLength (uint16_t length)
 
void SetMessageType (uint8_t messageType)
 
void SetNextExtensionType (uint8_t nextExtensionType)
 
void SetNPduNumber (uint8_t nPduNumber)
 
void SetNPduNumberFlag (bool nPduNumberFlag)
 
void SetProtocolType (bool protocolType)
 
void SetSequenceNumber (uint16_t sequenceNumber)
 
void SetSequenceNumberFlag (bool sequenceNumberFlag)
 
void SetTeid (uint32_t teid)
 
void SetVersion (uint8_t version)
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 

Detailed Description

Implementation of the GPRS Tunnelling Protocol header according to GTPv1-U Release 10 as per 3Gpp TS 29.281 document

Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 24 bytes (on a 64-bit architecture).

Definition at line 26 of file nr-epc-gtpu-header.h.

Constructor & Destructor Documentation

◆ NrGtpuHeader()

ns3::NrGtpuHeader::NrGtpuHeader ( )

Definition at line 33 of file nr-epc-gtpu-header.cc.

◆ ~NrGtpuHeader()

ns3::NrGtpuHeader::~NrGtpuHeader ( )
override

Definition at line 48 of file nr-epc-gtpu-header.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::NrGtpuHeader::Deserialize ( Buffer::Iterator  start)
override

Definition at line 80 of file nr-epc-gtpu-header.cc.

◆ GetExtensionHeaderFlag()

bool ns3::NrGtpuHeader::GetExtensionHeaderFlag ( ) const

Get extension header flag function

Returns
the extension header flag

Definition at line 125 of file nr-epc-gtpu-header.cc.

◆ GetInstanceTypeId()

TypeId ns3::NrGtpuHeader::GetInstanceTypeId ( ) const
override

Definition at line 53 of file nr-epc-gtpu-header.cc.

◆ GetLength()

uint16_t ns3::NrGtpuHeader::GetLength ( ) const

Get length function

Returns
the length

Definition at line 131 of file nr-epc-gtpu-header.cc.

◆ GetMessageType()

uint8_t ns3::NrGtpuHeader::GetMessageType ( ) const

Get message type function

Returns
the message type

Definition at line 137 of file nr-epc-gtpu-header.cc.

◆ GetNextExtensionType()

uint8_t ns3::NrGtpuHeader::GetNextExtensionType ( ) const

Get next extension type function

Returns
the next extension type

Definition at line 155 of file nr-epc-gtpu-header.cc.

◆ GetNPduNumber()

uint8_t ns3::NrGtpuHeader::GetNPduNumber ( ) const

Get NPDU number function

Returns
the NPDU number

Definition at line 143 of file nr-epc-gtpu-header.cc.

◆ GetNPduNumberFlag()

bool ns3::NrGtpuHeader::GetNPduNumberFlag ( ) const

Get type of GTP-U message function

Returns
the NPDU number flag

Definition at line 149 of file nr-epc-gtpu-header.cc.

◆ GetProtocolType()

bool ns3::NrGtpuHeader::GetProtocolType ( ) const

Get protocol type function

Returns
the protocol type

Definition at line 161 of file nr-epc-gtpu-header.cc.

◆ GetSequenceNumber()

uint16_t ns3::NrGtpuHeader::GetSequenceNumber ( ) const

Get protocol type function

Returns
the sequence number

Definition at line 167 of file nr-epc-gtpu-header.cc.

◆ GetSequenceNumberFlag()

bool ns3::NrGtpuHeader::GetSequenceNumberFlag ( ) const

Get sequence number flag function

Returns
the sequence number flag

Definition at line 173 of file nr-epc-gtpu-header.cc.

◆ GetSerializedSize()

uint32_t ns3::NrGtpuHeader::GetSerializedSize ( ) const
override

Definition at line 59 of file nr-epc-gtpu-header.cc.

◆ GetTeid()

uint32_t ns3::NrGtpuHeader::GetTeid ( ) const

Get a tunnel endpoint identificator (TEID)

Returns
the TEID

Definition at line 179 of file nr-epc-gtpu-header.cc.

Referenced by ns3::NrEpcGnbApplication::RecvFromS1uSocket(), ns3::NrEpcPgwApplication::RecvFromS5uSocket(), and ns3::NrEpcX2::RecvFromX2uSocket().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::NrGtpuHeader::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 24 of file nr-epc-gtpu-header.cc.

◆ GetVersion()

uint8_t ns3::NrGtpuHeader::GetVersion ( ) const

Get version function

Returns
the version

Definition at line 185 of file nr-epc-gtpu-header.cc.

◆ operator==()

bool ns3::NrGtpuHeader::operator== ( const NrGtpuHeader b) const

Equality operator.

Parameters
bNrGtpuHeader object to compare
Returns
true of equal

Definition at line 258 of file nr-epc-gtpu-header.cc.

◆ Print()

void ns3::NrGtpuHeader::Print ( std::ostream &  os) const
override

Definition at line 99 of file nr-epc-gtpu-header.cc.

◆ Serialize()

void ns3::NrGtpuHeader::Serialize ( Buffer::Iterator  start) const
override

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

◆ SetExtensionHeaderFlag()

void ns3::NrGtpuHeader::SetExtensionHeaderFlag ( bool  extensionHeaderFlag)

Set extension header flag function

Parameters
extensionHeaderFlag

Definition at line 191 of file nr-epc-gtpu-header.cc.

◆ SetLength()

void ns3::NrGtpuHeader::SetLength ( uint16_t  length)

Set the length in octets of the payload

Parameters
lengththe length

Definition at line 197 of file nr-epc-gtpu-header.cc.

Referenced by ns3::NrEpcX2::DoSendUeData(), and ns3::NrEpcPgwApplication::SendToS5uSocket().

+ Here is the caller graph for this function:

◆ SetMessageType()

void ns3::NrGtpuHeader::SetMessageType ( uint8_t  messageType)

Set message type function

Parameters
messageTypethe message type

Definition at line 203 of file nr-epc-gtpu-header.cc.

◆ SetNextExtensionType()

void ns3::NrGtpuHeader::SetNextExtensionType ( uint8_t  nextExtensionType)

Set next extension type function

Parameters
nextExtensionTypethe next extension type

Definition at line 221 of file nr-epc-gtpu-header.cc.

◆ SetNPduNumber()

void ns3::NrGtpuHeader::SetNPduNumber ( uint8_t  nPduNumber)

Set NPDU number function

Parameters
nPduNumberthe NPDU number

Definition at line 209 of file nr-epc-gtpu-header.cc.

◆ SetNPduNumberFlag()

void ns3::NrGtpuHeader::SetNPduNumberFlag ( bool  nPduNumberFlag)

Sets the flag that indicates the presence of a meaningful value of the N-PDU Number field.

Parameters
nPduNumberFlagthe NPDU number flag

Definition at line 215 of file nr-epc-gtpu-header.cc.

◆ SetProtocolType()

void ns3::NrGtpuHeader::SetProtocolType ( bool  protocolType)

Set protocol type function

Parameters
protocolTypethe protocol type

Definition at line 227 of file nr-epc-gtpu-header.cc.

◆ SetSequenceNumber()

void ns3::NrGtpuHeader::SetSequenceNumber ( uint16_t  sequenceNumber)

Set sequence number function

Parameters
sequenceNumberthe sequence number

Definition at line 233 of file nr-epc-gtpu-header.cc.

◆ SetSequenceNumberFlag()

void ns3::NrGtpuHeader::SetSequenceNumberFlag ( bool  sequenceNumberFlag)

Set sequence number flag function

Parameters
sequenceNumberFlagthe sequence number flag

Definition at line 239 of file nr-epc-gtpu-header.cc.

◆ SetTeid()

void ns3::NrGtpuHeader::SetTeid ( uint32_t  teid)

Set TEID function

Parameters
teidthe TEID

Definition at line 245 of file nr-epc-gtpu-header.cc.

Referenced by ns3::NrEpcX2::DoSendUeData(), and ns3::NrEpcPgwApplication::SendToS5uSocket().

+ Here is the caller graph for this function:

◆ SetVersion()

void ns3::NrGtpuHeader::SetVersion ( uint8_t  version)

Set version function

Parameters
versionthe version

Definition at line 251 of file nr-epc-gtpu-header.cc.


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