Headers for A-MPDU subframes. More...
#include "ampdu-subframe-header.h"
Public Member Functions | |
AmpduSubframeHeader () | |
~AmpduSubframeHeader () override | |
uint32_t | Deserialize (Buffer::Iterator start) override |
bool | GetEof () const |
Return the EOF field. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint16_t | GetLength () const |
Return the length field. | |
uint32_t | GetSerializedSize () const override |
bool | IsSignatureValid () const |
Return whether the pattern stored in the delimiter signature field is correct, i.e. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetEof (bool eof) |
Set the EOF field. | |
void | SetLength (uint16_t length) |
Set the length 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 | |
bool | m_eof |
EOF field. | |
uint16_t | m_length |
length field in bytes | |
uint8_t | m_signature |
delimiter signature (should correspond to pattern 0x4E in order to be assumed valid) | |
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. | |
Headers for A-MPDU subframes.
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wifi
Size of this type is 16 bytes (on a 64-bit architecture).
Definition at line 21 of file ampdu-subframe-header.h.
ns3::AmpduSubframeHeader::AmpduSubframeHeader | ( | ) |
Definition at line 34 of file ampdu-subframe-header.cc.
|
override |
Definition at line 41 of file ampdu-subframe-header.cc.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 60 of file ampdu-subframe-header.cc.
References ns3::Buffer::Iterator::GetDistanceFrom(), m_eof, m_length, m_signature, ns3::Buffer::Iterator::ReadLsbtohU16(), and ns3::Buffer::Iterator::ReadU8().
bool ns3::AmpduSubframeHeader::GetEof | ( | ) | const |
Return the EOF field.
Definition at line 97 of file ampdu-subframe-header.cc.
References m_eof.
Referenced by ns3::WifiPhyHelper::GetRadiotapHeader().
|
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.
Implements ns3::ObjectBase.
Definition at line 29 of file ampdu-subframe-header.cc.
References GetTypeId().
uint16_t ns3::AmpduSubframeHeader::GetLength | ( | ) | const |
Return the length field.
Definition at line 91 of file ampdu-subframe-header.cc.
References m_length.
Referenced by ns3::WifiPhyHelper::GetRadiotapHeader(), and TracePacketReception().
|
overridevirtual |
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 46 of file ampdu-subframe-header.cc.
|
static |
Get the type ID.
Definition at line 19 of file ampdu-subframe-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
bool ns3::AmpduSubframeHeader::IsSignatureValid | ( | ) | const |
Return whether the pattern stored in the delimiter signature field is correct, i.e.
corresponds to the unique pattern 0x4E.
Definition at line 103 of file ampdu-subframe-header.cc.
References m_signature.
|
overridevirtual |
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 72 of file ampdu-subframe-header.cc.
References m_eof, m_length, and m_signature.
|
overridevirtual |
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 52 of file ampdu-subframe-header.cc.
References m_eof, m_length, m_signature, ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().
void ns3::AmpduSubframeHeader::SetEof | ( | bool | eof | ) |
Set the EOF field.
eof | set EOF field if true |
Definition at line 85 of file ampdu-subframe-header.cc.
References m_eof.
Referenced by ns3::MpduAggregator::GetAmpduSubframeHeader().
void ns3::AmpduSubframeHeader::SetLength | ( | uint16_t | length | ) |
Set the length field.
length | in bytes |
Definition at line 79 of file ampdu-subframe-header.cc.
References m_length.
Referenced by ns3::MpduAggregator::GetAmpduSubframeHeader().
|
private |
EOF field.
Definition at line 74 of file ampdu-subframe-header.h.
Referenced by Deserialize(), GetEof(), Print(), Serialize(), and SetEof().
|
private |
length field in bytes
Definition at line 73 of file ampdu-subframe-header.h.
Referenced by Deserialize(), GetLength(), Print(), Serialize(), and SetLength().
|
private |
delimiter signature (should correspond to pattern 0x4E in order to be assumed valid)
Definition at line 75 of file ampdu-subframe-header.h.
Referenced by Deserialize(), IsSignatureValid(), Print(), and Serialize().