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

Implements the IEEE 802.11 MAC trailer. More...

#include "wifi-mac-trailer.h"

+ Inheritance diagram for ns3::WifiMacTrailer:
+ Collaboration diagram for ns3::WifiMacTrailer:

Public Member Functions

 WifiMacTrailer ()
 
 ~WifiMacTrailer () override
 
uint32_t Deserialize (Buffer::Iterator start) override
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
- Public Member Functions inherited from ns3::Trailer
 ~Trailer () override
 
uint32_t Deserialize (Buffer::Iterator end) override=0
 
uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end) override
 
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::Trailer
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.
 

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

Implements the IEEE 802.11 MAC trailer.

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 8 bytes (on a 64-bit architecture).

Definition at line 38 of file wifi-mac-trailer.h.

Constructor & Destructor Documentation

◆ WifiMacTrailer()

ns3::WifiMacTrailer::WifiMacTrailer ( )

Definition at line 27 of file wifi-mac-trailer.cc.

◆ ~WifiMacTrailer()

ns3::WifiMacTrailer::~WifiMacTrailer ( )
override

Definition at line 31 of file wifi-mac-trailer.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::WifiMacTrailer::Deserialize ( Buffer::Iterator  end)
overridevirtual
Parameters
endan iterator which points to the end of the buffer where the trailer should be read from.
Returns
the number of bytes read.

This method is used by Packet::RemoveTrailer to re-create a trailer from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this trailer in real networks. The input iterator points to the end of the area where the data shall be read from. This method is thus expected to call Buffer::Iterator::Prev prior to actually reading any data.

Implements ns3::Trailer.

Definition at line 70 of file wifi-mac-trailer.cc.

References ns3::WIFI_MAC_FCS_LENGTH.

◆ GetInstanceTypeId()

TypeId ns3::WifiMacTrailer::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 46 of file wifi-mac-trailer.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::WifiMacTrailer::GetSerializedSize ( ) const
overridevirtual
Returns
the expected size of the trailer.

This method is used by Packet::AddTrailer to store a trailer into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full trailer data by Serialize.

Implements ns3::Trailer.

Definition at line 57 of file wifi-mac-trailer.cc.

References ns3::WIFI_MAC_FCS_LENGTH.

Referenced by ns3::GetSize().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::WifiMacTrailer::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 36 of file wifi-mac-trailer.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::WifiMacTrailer::Print ( std::ostream &  os) const
overridevirtual
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::Trailer.

Definition at line 52 of file wifi-mac-trailer.cc.

◆ Serialize()

void ns3::WifiMacTrailer::Serialize ( Buffer::Iterator  start) const
overridevirtual
Parameters
startan iterator which points to where the trailer should be written.

This method is used by Packet::AddTrailer 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 trailer in real networks. The input iterator points to the end of the area where the data shall be written. This method is thus expected to call Buffer::Iterator::Prev prior to actually writing any data.

Implements ns3::Trailer.

Definition at line 63 of file wifi-mac-trailer.cc.

References ns3::WIFI_MAC_FCS_LENGTH.


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