A Discrete-Event Network Simulator
API
ns3::EpcX2HandoverRequestHeader Class Reference

EpcX2HandoverRequestHeader. More...

#include "epc-x2-header.h"

+ Inheritance diagram for ns3::EpcX2HandoverRequestHeader:
+ Collaboration diagram for ns3::EpcX2HandoverRequestHeader:

Public Member Functions

 EpcX2HandoverRequestHeader ()
 
 ~EpcX2HandoverRequestHeader () override
 
uint32_t Deserialize (Buffer::Iterator start) override
 
std::vector< EpcX2Sap::ErabToBeSetupItemGetBearers () const
 Get bearers function. More...
 
uint16_t GetCause () const
 Get cause function. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
uint32_t GetLengthOfIes () const
 Get length of IEs. More...
 
uint32_t GetMmeUeS1apId () const
 Get MME UE S1 AP ID function. More...
 
uint32_t GetNumberOfIes () const
 Get number of IEs. More...
 
uint16_t GetOldEnbUeX2apId () const
 Get old ENB X2 AP ID function. More...
 
uint32_t GetSerializedSize () const override
 
uint16_t GetTargetCellId () const
 Get target cell id function. More...
 
uint64_t GetUeAggregateMaxBitRateDownlink () const
 Get UE Aggregate Max Bit Rate Downlink function. More...
 
uint64_t GetUeAggregateMaxBitRateUplink () const
 Get UE Aggregate Max Bit Rate Uplik function. More...
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
void SetBearers (std::vector< EpcX2Sap::ErabToBeSetupItem > bearers)
 Set bearers function. More...
 
void SetCause (uint16_t cause)
 Set cause function. More...
 
void SetMmeUeS1apId (uint32_t mmeUeS1apId)
 Set MME UE S1 AP ID function. More...
 
void SetOldEnbUeX2apId (uint16_t x2apId)
 Set old ENB X2 AP ID function. More...
 
void SetTargetCellId (uint16_t targetCellId)
 Set target cell id function. More...
 
void SetUeAggregateMaxBitRateDownlink (uint64_t bitRate)
 Set UE Aggregate Max Bit Rate Downlink function. More...
 
void SetUeAggregateMaxBitRateUplink (uint64_t bitRate)
 Set UE Aggregate Max Bit Rate Uplik function. More...
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Attributes

uint16_t m_cause
 cause More...
 
std::vector< EpcX2Sap::ErabToBeSetupItemm_erabsToBeSetupList
 ERAB to be setup list. More...
 
uint32_t m_headerLength
 header length More...
 
uint32_t m_mmeUeS1apId
 MME UE S1 AP ID. More...
 
uint32_t m_numberOfIes
 number of IEs More...
 
uint16_t m_oldEnbUeX2apId
 old ENB UE X1 AP ID More...
 
uint16_t m_targetCellId
 target cell ID More...
 
uint64_t m_ueAggregateMaxBitRateDownlink
 aggregate max bit rate downlink More...
 
uint64_t m_ueAggregateMaxBitRateUplink
 aggregate max bit rate uplink More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

EpcX2HandoverRequestHeader.

Definition at line 112 of file epc-x2-header.h.

Constructor & Destructor Documentation

◆ EpcX2HandoverRequestHeader()

ns3::EpcX2HandoverRequestHeader::EpcX2HandoverRequestHeader ( )

Definition at line 148 of file epc-x2-header.cc.

References m_erabsToBeSetupList.

◆ ~EpcX2HandoverRequestHeader()

ns3::EpcX2HandoverRequestHeader::~EpcX2HandoverRequestHeader ( )
override

Member Function Documentation

◆ Deserialize()

uint32_t ns3::EpcX2HandoverRequestHeader::Deserialize ( Buffer::Iterator  start)
overridevirtual
Parameters
startan iterator which points to where the header should read from.
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.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 240 of file epc-x2-header.cc.

References ns3::EpsBearer::arp, ns3::EpcX2Sap::ErabToBeSetupItem::dlForwarding, ns3::EpcX2Sap::ErabToBeSetupItem::erabId, ns3::EpcX2Sap::ErabToBeSetupItem::erabLevelQosParameters, ns3::GbrQosInformation::gbrDl, ns3::EpsBearer::gbrQosInfo, ns3::GbrQosInformation::gbrUl, GetSerializedSize(), ns3::EpcX2Sap::ErabToBeSetupItem::gtpTeid, m_cause, m_erabsToBeSetupList, m_headerLength, m_mmeUeS1apId, m_numberOfIes, m_oldEnbUeX2apId, m_targetCellId, m_ueAggregateMaxBitRateDownlink, m_ueAggregateMaxBitRateUplink, ns3::GbrQosInformation::mbrDl, ns3::GbrQosInformation::mbrUl, ns3::AllocationRetentionPriority::preemptionCapability, ns3::AllocationRetentionPriority::preemptionVulnerability, ns3::AllocationRetentionPriority::priorityLevel, ns3::Buffer::Iterator::ReadNtohU16(), ns3::Buffer::Iterator::ReadNtohU32(), ns3::Buffer::Iterator::ReadNtohU64(), ns3::Buffer::Iterator::ReadU8(), two-ray-to-three-gpp-ch-calibration::start, and ns3::EpcX2Sap::ErabToBeSetupItem::transportLayerAddress.

+ Here is the call graph for this function:

◆ GetBearers()

std::vector< EpcX2Sap::ErabToBeSetupItem > ns3::EpcX2HandoverRequestHeader::GetBearers ( ) const

Get bearers function.

Returns
<EpcX2Sap::ErabToBeSetupItem>

Definition at line 383 of file epc-x2-header.cc.

References m_erabsToBeSetupList.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ GetCause()

uint16_t ns3::EpcX2HandoverRequestHeader::GetCause ( ) const

Get cause function.

Returns
the cause

Definition at line 347 of file epc-x2-header.cc.

References m_cause.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::EpcX2HandoverRequestHeader::GetInstanceTypeId ( ) const
overridevirtual

Get the most derived TypeId for this Object.

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

Returns
The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 181 of file epc-x2-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetLengthOfIes()

uint32_t ns3::EpcX2HandoverRequestHeader::GetLengthOfIes ( ) const

Get length of IEs.

Returns
the length of IEs

Definition at line 420 of file epc-x2-header.cc.

References m_headerLength.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ GetMmeUeS1apId()

uint32_t ns3::EpcX2HandoverRequestHeader::GetMmeUeS1apId ( ) const

Get MME UE S1 AP ID function.

Returns
the MME UE S1 AP ID

Definition at line 371 of file epc-x2-header.cc.

References m_mmeUeS1apId.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ GetNumberOfIes()

uint32_t ns3::EpcX2HandoverRequestHeader::GetNumberOfIes ( ) const

Get number of IEs.

Returns
the number of IEs

Definition at line 426 of file epc-x2-header.cc.

References m_numberOfIes.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ GetOldEnbUeX2apId()

uint16_t ns3::EpcX2HandoverRequestHeader::GetOldEnbUeX2apId ( ) const

Get old ENB X2 AP ID function.

Returns
the old ENB UE X2 AP ID

Definition at line 335 of file epc-x2-header.cc.

References m_oldEnbUeX2apId.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::EpcX2HandoverRequestHeader::GetSerializedSize ( ) const
overridevirtual
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 187 of file epc-x2-header.cc.

References m_headerLength.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetTargetCellId()

uint16_t ns3::EpcX2HandoverRequestHeader::GetTargetCellId ( ) const

Get target cell id function.

Returns
the target cell ID

Definition at line 359 of file epc-x2-header.cc.

References m_targetCellId.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::EpcX2HandoverRequestHeader::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 171 of file epc-x2-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetUeAggregateMaxBitRateDownlink()

uint64_t ns3::EpcX2HandoverRequestHeader::GetUeAggregateMaxBitRateDownlink ( ) const

Get UE Aggregate Max Bit Rate Downlink function.

Returns
the UE aggregate max bit rate downlink

Definition at line 396 of file epc-x2-header.cc.

References m_ueAggregateMaxBitRateDownlink.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ GetUeAggregateMaxBitRateUplink()

uint64_t ns3::EpcX2HandoverRequestHeader::GetUeAggregateMaxBitRateUplink ( ) const

Get UE Aggregate Max Bit Rate Uplik function.

Returns
the UE aggregate max bit rate uplink

Definition at line 408 of file epc-x2-header.cc.

References m_ueAggregateMaxBitRateUplink.

Referenced by ns3::EpcX2::RecvFromX2cSocket().

+ Here is the caller graph for this function:

◆ Print()

void ns3::EpcX2HandoverRequestHeader::Print ( std::ostream &  os) const
overridevirtual
Parameters
osoutput stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header 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 305 of file epc-x2-header.cc.

References m_cause, m_erabsToBeSetupList, m_mmeUeS1apId, m_oldEnbUeX2apId, m_targetCellId, m_ueAggregateMaxBitRateDownlink, and m_ueAggregateMaxBitRateUplink.

◆ Serialize()

void ns3::EpcX2HandoverRequestHeader::Serialize ( Buffer::Iterator  start) const
overridevirtual
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 193 of file epc-x2-header.cc.

References m_cause, m_erabsToBeSetupList, m_mmeUeS1apId, m_oldEnbUeX2apId, m_targetCellId, m_ueAggregateMaxBitRateDownlink, m_ueAggregateMaxBitRateUplink, two-ray-to-three-gpp-ch-calibration::start, ns3::Buffer::Iterator::WriteHtonU16(), ns3::Buffer::Iterator::WriteHtonU32(), ns3::Buffer::Iterator::WriteHtonU64(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetBearers()

void ns3::EpcX2HandoverRequestHeader::SetBearers ( std::vector< EpcX2Sap::ErabToBeSetupItem bearers)

Set bearers function.

Parameters
bearersstd::vector <EpcX2Sap::ErabToBeSetupItem>

Definition at line 389 of file epc-x2-header.cc.

References m_erabsToBeSetupList, and m_headerLength.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ SetCause()

void ns3::EpcX2HandoverRequestHeader::SetCause ( uint16_t  cause)

Set cause function.

Parameters
cause

Definition at line 353 of file epc-x2-header.cc.

References m_cause.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ SetMmeUeS1apId()

void ns3::EpcX2HandoverRequestHeader::SetMmeUeS1apId ( uint32_t  mmeUeS1apId)

Set MME UE S1 AP ID function.

Parameters
mmeUeS1apIdthe MME UE S1 AP ID

Definition at line 377 of file epc-x2-header.cc.

References m_mmeUeS1apId.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ SetOldEnbUeX2apId()

void ns3::EpcX2HandoverRequestHeader::SetOldEnbUeX2apId ( uint16_t  x2apId)

Set old ENB X2 AP ID function.

Parameters
x2apIdthe X2 AP ID

Definition at line 341 of file epc-x2-header.cc.

References m_oldEnbUeX2apId.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ SetTargetCellId()

void ns3::EpcX2HandoverRequestHeader::SetTargetCellId ( uint16_t  targetCellId)

Set target cell id function.

Parameters
targetCellIdthe target cell ID

Definition at line 365 of file epc-x2-header.cc.

References m_targetCellId.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ SetUeAggregateMaxBitRateDownlink()

void ns3::EpcX2HandoverRequestHeader::SetUeAggregateMaxBitRateDownlink ( uint64_t  bitRate)

Set UE Aggregate Max Bit Rate Downlink function.

Parameters
bitRatethe bit rate

Definition at line 402 of file epc-x2-header.cc.

References m_ueAggregateMaxBitRateDownlink.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

◆ SetUeAggregateMaxBitRateUplink()

void ns3::EpcX2HandoverRequestHeader::SetUeAggregateMaxBitRateUplink ( uint64_t  bitRate)

Set UE Aggregate Max Bit Rate Uplik function.

Parameters
bitRatethe bit rate

Definition at line 414 of file epc-x2-header.cc.

References m_ueAggregateMaxBitRateUplink.

Referenced by ns3::EpcX2::DoSendHandoverRequest().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cause

uint16_t ns3::EpcX2HandoverRequestHeader::m_cause
private

cause

Definition at line 222 of file epc-x2-header.h.

Referenced by ~EpcX2HandoverRequestHeader(), Deserialize(), GetCause(), Print(), Serialize(), and SetCause().

◆ m_erabsToBeSetupList

std::vector<EpcX2Sap::ErabToBeSetupItem> ns3::EpcX2HandoverRequestHeader::m_erabsToBeSetupList
private

◆ m_headerLength

uint32_t ns3::EpcX2HandoverRequestHeader::m_headerLength
private

header length

Definition at line 219 of file epc-x2-header.h.

Referenced by ~EpcX2HandoverRequestHeader(), Deserialize(), GetLengthOfIes(), GetSerializedSize(), and SetBearers().

◆ m_mmeUeS1apId

uint32_t ns3::EpcX2HandoverRequestHeader::m_mmeUeS1apId
private

MME UE S1 AP ID.

Definition at line 224 of file epc-x2-header.h.

Referenced by ~EpcX2HandoverRequestHeader(), Deserialize(), GetMmeUeS1apId(), Print(), Serialize(), and SetMmeUeS1apId().

◆ m_numberOfIes

uint32_t ns3::EpcX2HandoverRequestHeader::m_numberOfIes
private

number of IEs

Definition at line 218 of file epc-x2-header.h.

Referenced by ~EpcX2HandoverRequestHeader(), Deserialize(), and GetNumberOfIes().

◆ m_oldEnbUeX2apId

uint16_t ns3::EpcX2HandoverRequestHeader::m_oldEnbUeX2apId
private

old ENB UE X1 AP ID

Definition at line 221 of file epc-x2-header.h.

Referenced by ~EpcX2HandoverRequestHeader(), Deserialize(), GetOldEnbUeX2apId(), Print(), Serialize(), and SetOldEnbUeX2apId().

◆ m_targetCellId

uint16_t ns3::EpcX2HandoverRequestHeader::m_targetCellId
private

target cell ID

Definition at line 223 of file epc-x2-header.h.

Referenced by ~EpcX2HandoverRequestHeader(), Deserialize(), GetTargetCellId(), Print(), Serialize(), and SetTargetCellId().

◆ m_ueAggregateMaxBitRateDownlink

uint64_t ns3::EpcX2HandoverRequestHeader::m_ueAggregateMaxBitRateDownlink
private

aggregate max bit rate downlink

Definition at line 225 of file epc-x2-header.h.

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

◆ m_ueAggregateMaxBitRateUplink

uint64_t ns3::EpcX2HandoverRequestHeader::m_ueAggregateMaxBitRateUplink
private

aggregate max bit rate uplink

Definition at line 226 of file epc-x2-header.h.

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


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