This class implements the DSA-ACK message described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.12 DSA-ACK message, page 64. More...

#include "mac-messages.h"

Inheritance diagram for ns3::DsaAck:

Collaboration diagram for ns3::DsaAck:

Public Member Functions
	DsaAck ()

	~DsaAck () override

uint32_t	Deserialize (Buffer::Iterator start) override

uint16_t	GetConfirmationCode () const
	Get confirmation code field.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

std::string	GetName () const
	Get name field.

uint32_t	GetSerializedSize () const override

uint16_t	GetTransactionId () const
	Get transaction ID field.

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

void	Serialize (Buffer::Iterator start) const override

void	SetConfirmationCode (uint16_t confirmationCode)
	Set confirmation code field.

void	SetTransactionId (uint16_t transactionId)
	Set transaction ID field.

Public Member Functions inherited from ns3::Header
	~Header () override

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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.

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
uint8_t	m_confirmationCode
	confirmation code

uint16_t	m_transactionId
	transaction 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.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

This class implements the DSA-ACK message described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.12 DSA-ACK message, page 64.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wimax

Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 577 of file mac-messages.h.

Constructor & Destructor Documentation

◆ DsaAck()

ns3::DsaAck::DsaAck ( )

Definition at line 763 of file mac-messages.cc.

◆ ~DsaAck()

ns3::DsaAck::~DsaAck ( )

override

Definition at line 769 of file mac-messages.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::DsaAck::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an 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 839 of file mac-messages.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_confirmationCode, m_transactionId, ns3::Buffer::Iterator::ReadU16(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetConfirmationCode()

uint16_t ns3::DsaAck::GetConfirmationCode ( ) const

Get confirmation code field.

Returns: the confirmation code

Definition at line 792 of file mac-messages.cc.

References m_confirmationCode.

◆ GetInstanceTypeId()

TypeId ns3::DsaAck::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

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

Implements ns3::ObjectBase.

Definition at line 812 of file mac-messages.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetName()

std::string ns3::DsaAck::GetName ( ) const

Get name field.

Returns: the name string

Definition at line 798 of file mac-messages.cc.

◆ GetSerializedSize()

uint32_t ns3::DsaAck::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 825 of file mac-messages.cc.

◆ GetTransactionId()

uint16_t ns3::DsaAck::GetTransactionId ( ) const

Get transaction ID field.

Returns: the transaction ID

Definition at line 780 of file mac-messages.cc.

References m_transactionId.

Referenced by ns3::BsServiceFlowManager::ProcessDsaAck().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::DsaAck::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 804 of file mac-messages.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::DsaAck::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output 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 818 of file mac-messages.cc.

References m_confirmationCode, and m_transactionId.

◆ Serialize()

void ns3::DsaAck::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an 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 831 of file mac-messages.cc.

References m_confirmationCode, m_transactionId, ns3::Buffer::Iterator::WriteU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetConfirmationCode()

void ns3::DsaAck::SetConfirmationCode ( uint16_t confirmationCode )

Set confirmation code field.

Parameters

confirmationCode the confirmation code

Definition at line 786 of file mac-messages.cc.

References m_confirmationCode.

Referenced by ns3::SsServiceFlowManager::CreateDsaAck().

Here is the caller graph for this function:

◆ SetTransactionId()

void ns3::DsaAck::SetTransactionId ( uint16_t transactionId )

Set transaction ID field.

Parameters

transactionId the transaction ID

Definition at line 774 of file mac-messages.cc.

References m_transactionId.

Referenced by ns3::SsServiceFlowManager::CreateDsaAck().

Here is the caller graph for this function:

Member Data Documentation

◆ m_confirmationCode

uint8_t ns3::DsaAck::m_confirmationCode

private

confirmation code

Definition at line 623 of file mac-messages.h.

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

◆ m_transactionId

uint16_t ns3::DsaAck::m_transactionId

private

transaction ID

Definition at line 622 of file mac-messages.h.

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

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

src/wimax/model/mac-messages.h
src/wimax/model/mac-messages.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DsaAck()

◆ ~DsaAck()

Member Function Documentation

◆ Deserialize()

◆ GetConfirmationCode()

◆ GetInstanceTypeId()

◆ GetName()

◆ GetSerializedSize()

◆ GetTransactionId()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetConfirmationCode()

◆ SetTransactionId()

Member Data Documentation

◆ m_confirmationCode

◆ m_transactionId