A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::MgtDelBaHeader Class Reference

Implement the header for management frames of type del block ack. More...

#include <mgt-headers.h>

+ Inheritance diagram for ns3::MgtDelBaHeader:
+ Collaboration diagram for ns3::MgtDelBaHeader:

Public Member Functions

 MgtDelBaHeader ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
uint8_t GetTid (void) const
 Return the Traffic ID (TID). More...
 
bool IsByOriginator (void) const
 Check if the initiator bit in the DELBA is setted. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetByOriginator (void)
 Set the initiator bit in the DELBA. More...
 
void SetByRecipient (void)
 Un-set the initiator bit in the DELBA. More...
 
void SetTid (uint8_t)
 Set Traffic ID (TID). More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 Get the type ID. More...
 

Private Member Functions

uint16_t GetParameterSet (void) const
 Return the raw parameter set. More...
 
void SetParameterSet (uint16_t params)
 Set the parameter set from the given raw value. More...
 

Private Attributes

uint16_t m_initiator
 
uint16_t m_reasonCode
 
uint16_t m_tid
 Traffic ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Implement the header for management frames of type del block ack.

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 698 of file mgt-headers.h.

Constructor & Destructor Documentation

ns3::MgtDelBaHeader::MgtDelBaHeader ( )

Definition at line 991 of file mgt-headers.cc.

Member Function Documentation

uint32_t ns3::MgtDelBaHeader::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 1035 of file mgt-headers.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_reasonCode, ns3::Buffer::Iterator::ReadLsbtohU16(), SetParameterSet(), and visualizer.core::start().

+ Here is the call graph for this function:

TypeId ns3::MgtDelBaHeader::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 1007 of file mgt-headers.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint16_t ns3::MgtDelBaHeader::GetParameterSet ( void  ) const
private

Return the raw parameter set.

Returns
the raw parameter set

Definition at line 1077 of file mgt-headers.cc.

References m_initiator, and m_tid.

Referenced by Serialize().

+ Here is the caller graph for this function:

uint32_t ns3::MgtDelBaHeader::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 1018 of file mgt-headers.cc.

uint8_t ns3::MgtDelBaHeader::GetTid ( void  ) const

Return the Traffic ID (TID).

Returns
TID

Definition at line 1050 of file mgt-headers.cc.

References m_tid, and NS_ASSERT.

Referenced by ns3::EdcaTxopN::GotAck(), ns3::EdcaTxopN::GotDelBaFrame(), and ns3::RegularWifiMac::Receive().

+ Here is the caller graph for this function:

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

Definition at line 997 of file mgt-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::MgtDelBaHeader::IsByOriginator ( void  ) const

Check if the initiator bit in the DELBA is setted.

Returns
true if the initiator bit in the DELBA is setted, false otherwise

Definition at line 1044 of file mgt-headers.cc.

References m_initiator.

Referenced by ns3::EdcaTxopN::GotAck(), and ns3::RegularWifiMac::Receive().

+ Here is the caller graph for this function:

void ns3::MgtDelBaHeader::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 1013 of file mgt-headers.cc.

void ns3::MgtDelBaHeader::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 1027 of file mgt-headers.cc.

References GetParameterSet(), m_reasonCode, visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().

+ Here is the call graph for this function:

void ns3::MgtDelBaHeader::SetByOriginator ( void  )

Set the initiator bit in the DELBA.

Definition at line 1058 of file mgt-headers.cc.

References m_initiator.

Referenced by ns3::EdcaTxopN::SendDelbaFrame().

+ Here is the caller graph for this function:

void ns3::MgtDelBaHeader::SetByRecipient ( void  )

Un-set the initiator bit in the DELBA.

Definition at line 1064 of file mgt-headers.cc.

References m_initiator.

Referenced by ns3::EdcaTxopN::SendDelbaFrame().

+ Here is the caller graph for this function:

void ns3::MgtDelBaHeader::SetParameterSet ( uint16_t  params)
private

Set the parameter set from the given raw value.

Parameters
paramsraw parameter set value

Definition at line 1086 of file mgt-headers.cc.

References m_initiator, and m_tid.

Referenced by Deserialize().

+ Here is the caller graph for this function:

void ns3::MgtDelBaHeader::SetTid ( uint8_t  tid)

Set Traffic ID (TID).

Parameters
tidtraffic ID

Definition at line 1070 of file mgt-headers.cc.

References m_tid, and NS_ASSERT.

Referenced by ns3::EdcaTxopN::SendDelbaFrame().

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::MgtDelBaHeader::m_initiator
private
uint16_t ns3::MgtDelBaHeader::m_reasonCode
private

Definition at line 756 of file mgt-headers.h.

Referenced by Deserialize(), and Serialize().

uint16_t ns3::MgtDelBaHeader::m_tid
private

Traffic ID.

Definition at line 753 of file mgt-headers.h.

Referenced by GetParameterSet(), GetTid(), SetParameterSet(), and SetTid().


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