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


Introspection did not find any typical Config paths. More...

#include "amsdu-subframe-header.h"

+ Inheritance diagram for ns3::AmsduSubframeHeader:
+ Collaboration diagram for ns3::AmsduSubframeHeader:

Public Member Functions

 AmsduSubframeHeader ()
 
virtual ~AmsduSubframeHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
Mac48Address GetDestinationAddr (void) const
 Get destination address function. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint16_t GetLength (void) const
 Get length function. More...
 
uint32_t GetSerializedSize (void) const
 
Mac48Address GetSourceAddr (void) const
 Get source address function. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetDestinationAddr (Mac48Address to)
 Set destination address function. More...
 
void SetLength (uint16_t length)
 Set length function. More...
 
void SetSourceAddr (Mac48Address to)
 Set source address function. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 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 erros. 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 (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Mac48Address m_da
 destination address More...
 
uint16_t m_length
 length More...
 
Mac48Address m_sa
 source address 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description


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 32 of file amsdu-subframe-header.h.

Constructor & Destructor Documentation

◆ AmsduSubframeHeader()

ns3::AmsduSubframeHeader::AmsduSubframeHeader ( )

Definition at line 45 of file amsdu-subframe-header.cc.

◆ ~AmsduSubframeHeader()

ns3::AmsduSubframeHeader::~AmsduSubframeHeader ( )
virtual

Definition at line 50 of file amsdu-subframe-header.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::AmsduSubframeHeader::Deserialize ( Buffer::Iterator  start)
virtual
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 69 of file amsdu-subframe-header.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_da, m_length, m_sa, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadNtohU16(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetDestinationAddr()

Mac48Address ns3::AmsduSubframeHeader::GetDestinationAddr ( void  ) const

Get destination address function.

Returns
the destination MAC address

Definition at line 103 of file amsdu-subframe-header.cc.

References m_da.

◆ GetInstanceTypeId()

TypeId ns3::AmsduSubframeHeader::GetInstanceTypeId ( void  ) const
virtual

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 40 of file amsdu-subframe-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetLength()

uint16_t ns3::AmsduSubframeHeader::GetLength ( void  ) const

Get length function.

Returns
the length

Definition at line 115 of file amsdu-subframe-header.cc.

References m_length.

Referenced by ns3::MsduAggregator::Deaggregate().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::AmsduSubframeHeader::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 55 of file amsdu-subframe-header.cc.

◆ GetSourceAddr()

Mac48Address ns3::AmsduSubframeHeader::GetSourceAddr ( void  ) const

Get source address function.

Returns
the source MAC address

Definition at line 109 of file amsdu-subframe-header.cc.

References m_sa.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file amsdu-subframe-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::AmsduSubframeHeader::Print ( std::ostream &  os) const
virtual
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 79 of file amsdu-subframe-header.cc.

References m_da, m_length, and m_sa.

◆ Serialize()

void ns3::AmsduSubframeHeader::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 61 of file amsdu-subframe-header.cc.

References m_da, m_length, m_sa, ns3::Buffer::Iterator::WriteHtonU16(), and ns3::WriteTo().

+ Here is the call graph for this function:

◆ SetDestinationAddr()

void ns3::AmsduSubframeHeader::SetDestinationAddr ( Mac48Address  to)

Set destination address function.

Parameters
tothe destination MAC address

Definition at line 85 of file amsdu-subframe-header.cc.

References m_da.

Referenced by ns3::WifiMacQueueItem::DoAggregate().

+ Here is the caller graph for this function:

◆ SetLength()

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

Set length function.

Parameters
lengththe length

Definition at line 97 of file amsdu-subframe-header.cc.

References m_length.

Referenced by ns3::WifiMacQueueItem::DoAggregate().

+ Here is the caller graph for this function:

◆ SetSourceAddr()

void ns3::AmsduSubframeHeader::SetSourceAddr ( Mac48Address  to)

Set source address function.

Parameters
tothe source MAC address

Definition at line 91 of file amsdu-subframe-header.cc.

References m_sa.

Referenced by ns3::WifiMacQueueItem::DoAggregate().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_da

Mac48Address ns3::AmsduSubframeHeader::m_da
private

destination address

Definition at line 81 of file amsdu-subframe-header.h.

Referenced by Deserialize(), GetDestinationAddr(), Print(), Serialize(), and SetDestinationAddr().

◆ m_length

uint16_t ns3::AmsduSubframeHeader::m_length
private

length

Definition at line 83 of file amsdu-subframe-header.h.

Referenced by Deserialize(), GetLength(), Print(), Serialize(), and SetLength().

◆ m_sa

Mac48Address ns3::AmsduSubframeHeader::m_sa
private

source address

Definition at line 82 of file amsdu-subframe-header.h.

Referenced by Deserialize(), GetSourceAddr(), Print(), Serialize(), and SetSourceAddr().


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