A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::EpcX2HandoverCancelHeader Class Reference

EpcX2HandoverCancelHeader. More...

#include "epc-x2-header.h"

+ Inheritance diagram for ns3::EpcX2HandoverCancelHeader:
+ Collaboration diagram for ns3::EpcX2HandoverCancelHeader:

Public Member Functions

 EpcX2HandoverCancelHeader ()
 
 ~EpcX2HandoverCancelHeader () override
 
uint32_t Deserialize (Buffer::Iterator start) override
 
uint16_t GetCause () const
 Get cause function.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
uint32_t GetLengthOfIes () const
 Get length of IEs function.
 
uint16_t GetNewEnbUeX2apId () const
 Get new ENB UE X2 AP ID function.
 
uint32_t GetNumberOfIes () const
 Get number of IEs function.
 
uint16_t GetOldEnbUeX2apId () const
 Get old ENB UE X2 AP ID function.
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
void SetCause (uint16_t cause)
 Set cause function.
 
void SetNewEnbUeX2apId (uint16_t x2apId)
 Set new ENB UE X2 AP ID function.
 
void SetOldEnbUeX2apId (uint16_t x2apId)
 Set old ENB UE X2 AP ID function.
 
- Public Member Functions inherited from ns3::Header
 ~Header () override
 
uint32_t Deserialize (Buffer::Iterator start) override=0
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator.
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator.
 
virtual uint32_t GetSerializedSize () const =0
 
void Print (std::ostream &os) const override=0
 
virtual void Serialize (Buffer::Iterator start) const =0
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator.
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator.
 
virtual void Print (std::ostream &os) const =0
 Print the object contents.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

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

Private Attributes

uint16_t m_cause
 cause
 
uint32_t m_headerLength
 header length
 
uint16_t m_newEnbUeX2apId
 new ENB UE X2 AP ID
 
uint32_t m_numberOfIes
 number of IEs
 
uint16_t m_oldEnbUeX2apId
 old ENB UE X2 AP ID
 

Additional Inherited Members

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

Detailed Description

EpcX2HandoverCancelHeader.

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 652 of file epc-x2-header.h.

Constructor & Destructor Documentation

◆ EpcX2HandoverCancelHeader()

ns3::EpcX2HandoverCancelHeader::EpcX2HandoverCancelHeader ( )

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

◆ ~EpcX2HandoverCancelHeader()

ns3::EpcX2HandoverCancelHeader::~EpcX2HandoverCancelHeader ( )
override

Member Function Documentation

◆ Deserialize()

uint32_t ns3::EpcX2HandoverCancelHeader::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 1551 of file epc-x2-header.cc.

References GetSerializedSize(), m_cause, m_headerLength, m_newEnbUeX2apId, m_numberOfIes, m_oldEnbUeX2apId, and ns3::Buffer::Iterator::ReadNtohU16().

+ Here is the call graph for this function:

◆ GetCause()

uint16_t ns3::EpcX2HandoverCancelHeader::GetCause ( ) const

Get cause function.

Returns
the cause

Definition at line 1597 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::EpcX2HandoverCancelHeader::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 1529 of file epc-x2-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetLengthOfIes()

uint32_t ns3::EpcX2HandoverCancelHeader::GetLengthOfIes ( ) const

Get length of IEs function.

Returns
the length of IEs

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

References m_headerLength.

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

+ Here is the caller graph for this function:

◆ GetNewEnbUeX2apId()

uint16_t ns3::EpcX2HandoverCancelHeader::GetNewEnbUeX2apId ( ) const

Get new ENB UE X2 AP ID function.

Returns
the new ENB UE X2 AP ID

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

References m_newEnbUeX2apId.

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

+ Here is the caller graph for this function:

◆ GetNumberOfIes()

uint32_t ns3::EpcX2HandoverCancelHeader::GetNumberOfIes ( ) const

Get number of IEs function.

Returns
the number of IEs

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

References m_numberOfIes.

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

+ Here is the caller graph for this function:

◆ GetOldEnbUeX2apId()

uint16_t ns3::EpcX2HandoverCancelHeader::GetOldEnbUeX2apId ( ) const

Get old ENB UE X2 AP ID function.

Returns
the old ENB UE X2 AP ID

Definition at line 1573 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::EpcX2HandoverCancelHeader::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 1535 of file epc-x2-header.cc.

References m_headerLength.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::EpcX2HandoverCancelHeader::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 1519 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:

◆ Print()

void ns3::EpcX2HandoverCancelHeader::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 1565 of file epc-x2-header.cc.

References m_cause, m_newEnbUeX2apId, and m_oldEnbUeX2apId.

◆ Serialize()

void ns3::EpcX2HandoverCancelHeader::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 1541 of file epc-x2-header.cc.

References m_cause, m_newEnbUeX2apId, m_oldEnbUeX2apId, and ns3::Buffer::Iterator::WriteHtonU16().

+ Here is the call graph for this function:

◆ SetCause()

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

Set cause function.

Parameters
cause

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

References m_cause.

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

+ Here is the caller graph for this function:

◆ SetNewEnbUeX2apId()

void ns3::EpcX2HandoverCancelHeader::SetNewEnbUeX2apId ( uint16_t  x2apId)

Set new ENB UE X2 AP ID function.

Parameters
x2apIdthe new ENB UE X2 AP ID

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

References m_newEnbUeX2apId.

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

+ Here is the caller graph for this function:

◆ SetOldEnbUeX2apId()

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

Set old ENB UE X2 AP ID function.

Parameters
x2apIdthe old ENB UE X2 AP ID

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

References m_oldEnbUeX2apId.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cause

uint16_t ns3::EpcX2HandoverCancelHeader::m_cause
private

cause

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

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

◆ m_headerLength

uint32_t ns3::EpcX2HandoverCancelHeader::m_headerLength
private

header length

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

Referenced by ~EpcX2HandoverCancelHeader(), Deserialize(), GetLengthOfIes(), and GetSerializedSize().

◆ m_newEnbUeX2apId

uint16_t ns3::EpcX2HandoverCancelHeader::m_newEnbUeX2apId
private

new ENB UE X2 AP ID

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

Referenced by ~EpcX2HandoverCancelHeader(), Deserialize(), GetNewEnbUeX2apId(), Print(), Serialize(), and SetNewEnbUeX2apId().

◆ m_numberOfIes

uint32_t ns3::EpcX2HandoverCancelHeader::m_numberOfIes
private

number of IEs

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

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

◆ m_oldEnbUeX2apId

uint16_t ns3::EpcX2HandoverCancelHeader::m_oldEnbUeX2apId
private

old ENB UE X2 AP ID

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

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


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