This class implements the Generic mac Header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.1.1 Generic MAC header, page 36. More...
#include "wimax-mac-header.h"
Public Member Functions | |
GenericMacHeader () | |
~GenericMacHeader () override | |
bool | check_hcs () const |
Check HCS. | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint8_t | GetCi () const |
Get CI field. | |
Cid | GetCid () const |
Get CID field. | |
uint8_t | GetEc () const |
Get EC field. | |
uint8_t | GetEks () const |
Get EKS field. | |
uint8_t | GetHcs () const |
Get HCS field. | |
uint8_t | GetHt () const |
Get HT field. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint16_t | GetLen () const |
Get length field. | |
std::string | GetName () const |
Get name field. | |
uint32_t | GetSerializedSize () const override |
uint8_t | GetType () const |
Get type field. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetCi (uint8_t ci) |
Set CI field. | |
void | SetCid (Cid cid) |
Set CID field. | |
void | SetEc (uint8_t ec) |
Set EC field. | |
void | SetEks (uint8_t eks) |
Set EKS field. | |
void | SetHcs (uint8_t hcs) |
Set HCS field. | |
void | SetHt (uint8_t ht) |
Set HT field. | |
void | SetLen (uint16_t len) |
Set length field. | |
void | SetType (uint8_t type) |
Set type field. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
uint32_t | Deserialize (Buffer::Iterator start) override=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 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::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 | c_hcs |
calculated header check sequence; this is used to check if the received header is correct or not | |
uint8_t | m_ci |
CRC Indicator. | |
Cid | m_cid |
CID. | |
uint8_t | m_ec |
Encryption Control. | |
uint8_t | m_eks |
Encryption Key Sequence. | |
uint8_t | m_esf |
ESF. | |
uint8_t | m_hcs |
Header Check Sequence. | |
uint8_t | m_ht |
Header type. | |
uint16_t | m_len |
length | |
uint8_t | m_rsv1 |
RSV. | |
uint8_t | m_type |
type | |
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 Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
This class implements the Generic mac Header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.1.1 Generic MAC header, page 36.
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 113 of file wimax-mac-header.h.
ns3::GenericMacHeader::GenericMacHeader | ( | ) |
|
override |
Definition at line 121 of file wimax-mac-header.cc.
bool ns3::GenericMacHeader::check_hcs | ( | ) | const |
Check HCS.
Definition at line 326 of file wimax-mac-header.cc.
Referenced by ns3::BaseStationNetDevice::DoReceive(), and ns3::SubscriberStationNetDevice::DoReceive().
|
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 289 of file wimax-mac-header.cc.
References c_hcs, ns3::CRC8Calculate(), ns3::Buffer::Iterator::GetDistanceFrom(), m_ci, m_cid, m_ec, m_eks, m_esf, m_hcs, m_ht, m_len, m_rsv1, m_type, and ns3::Buffer::Iterator::ReadU8().
uint8_t ns3::GenericMacHeader::GetCi | ( | ) | const |
Cid ns3::GenericMacHeader::GetCid | ( | ) | const |
Get CID field.
Definition at line 210 of file wimax-mac-header.cc.
References m_cid.
Referenced by ns3::BSSchedulerRtps::BSSchedulerBasicConnection(), ns3::BSSchedulerRtps::BSSchedulerBEConnection(), ns3::BSSchedulerRtps::BSSchedulerBroadcastConnection(), ns3::BSSchedulerRtps::BSSchedulerInitialRangingConnection(), ns3::BSSchedulerRtps::BSSchedulerNRTPSConnection(), ns3::BSSchedulerRtps::BSSchedulerPrimaryConnection(), ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), ns3::BaseStationNetDevice::DoReceive(), and ns3::SubscriberStationNetDevice::DoReceive().
uint8_t ns3::GenericMacHeader::GetEc | ( | ) | const |
uint8_t ns3::GenericMacHeader::GetEks | ( | ) | const |
uint8_t ns3::GenericMacHeader::GetHcs | ( | ) | const |
uint8_t ns3::GenericMacHeader::GetHt | ( | ) | const |
Get HT field.
Definition at line 174 of file wimax-mac-header.cc.
References m_ht.
Referenced by ns3::BaseStationNetDevice::DoReceive(), and ns3::SubscriberStationNetDevice::DoReceive().
|
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 238 of file wimax-mac-header.cc.
References GetTypeId().
uint16_t ns3::GenericMacHeader::GetLen | ( | ) | const |
Get length field.
Definition at line 204 of file wimax-mac-header.cc.
References m_len.
std::string ns3::GenericMacHeader::GetName | ( | ) | const |
|
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 253 of file wimax-mac-header.cc.
Referenced by ns3::WimaxMacQueue::Dequeue(), Ns3WimaxFragmentationTestCase::DoRun(), ns3::BaseStationNetDevice::Enqueue(), ns3::SubscriberStationNetDevice::Enqueue(), and ns3::WimaxMacQueue::GetFirstPacketHdrSize().
uint8_t ns3::GenericMacHeader::GetType | ( | ) | const |
Get type field.
Definition at line 186 of file wimax-mac-header.cc.
References m_type.
Referenced by ns3::WimaxMacQueue::Dequeue(), ns3::BaseStationNetDevice::DoReceive(), ns3::SubscriberStationNetDevice::DoReceive(), and Ns3WimaxFragmentationTestCase::DoRun().
|
static |
Get the type ID.
Definition at line 228 of file wimax-mac-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
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 244 of file wimax-mac-header.cc.
References m_ci, m_cid, m_ec, m_eks, m_hcs, m_len, and m_type.
|
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 259 of file wimax-mac-header.cc.
References ns3::CRC8Calculate(), ns3::Cid::GetIdentifier(), m_ci, m_cid, m_ec, m_eks, m_esf, m_ht, m_len, m_rsv1, m_type, and ns3::Buffer::Iterator::WriteU8().
void ns3::GenericMacHeader::SetCi | ( | uint8_t | ci | ) |
Set CI field.
ci | the CI |
Definition at line 144 of file wimax-mac-header.cc.
References m_ci.
void ns3::GenericMacHeader::SetCid | ( | Cid | cid | ) |
Set CID field.
cid | the CID |
Definition at line 162 of file wimax-mac-header.cc.
References m_cid.
Referenced by Ns3WimaxFragmentationTestCase::DoRun(), ns3::BaseStationNetDevice::Enqueue(), and ns3::SubscriberStationNetDevice::Enqueue().
void ns3::GenericMacHeader::SetEc | ( | uint8_t | ec | ) |
Set EC field.
ec | the EC |
Definition at line 132 of file wimax-mac-header.cc.
References m_ec.
void ns3::GenericMacHeader::SetEks | ( | uint8_t | eks | ) |
Set EKS field.
eks | the EKS |
Definition at line 150 of file wimax-mac-header.cc.
References m_eks.
void ns3::GenericMacHeader::SetHcs | ( | uint8_t | hcs | ) |
Set HCS field.
hcs | the HCS |
Definition at line 168 of file wimax-mac-header.cc.
References m_hcs.
void ns3::GenericMacHeader::SetHt | ( | uint8_t | ht | ) |
Set HT field.
ht | the HT |
Definition at line 126 of file wimax-mac-header.cc.
References m_ht.
void ns3::GenericMacHeader::SetLen | ( | uint16_t | len | ) |
Set length field.
len | the length |
Definition at line 156 of file wimax-mac-header.cc.
References m_len.
Referenced by ns3::WimaxMacQueue::Dequeue(), Ns3WimaxFragmentationTestCase::DoRun(), ns3::BaseStationNetDevice::Enqueue(), and ns3::SubscriberStationNetDevice::Enqueue().
void ns3::GenericMacHeader::SetType | ( | uint8_t | type | ) |
Set type field.
type | the type |
Definition at line 138 of file wimax-mac-header.cc.
References m_type.
Referenced by ns3::WimaxMacQueue::Dequeue().
|
private |
calculated header check sequence; this is used to check if the received header is correct or not
Definition at line 232 of file wimax-mac-header.h.
Referenced by GenericMacHeader(), check_hcs(), and Deserialize().
|
private |
CRC Indicator.
Definition at line 226 of file wimax-mac-header.h.
Referenced by Deserialize(), GetCi(), Print(), Serialize(), and SetCi().
|
private |
CID.
Definition at line 230 of file wimax-mac-header.h.
Referenced by Deserialize(), GetCid(), Print(), Serialize(), and SetCid().
|
private |
Encryption Control.
Definition at line 223 of file wimax-mac-header.h.
Referenced by Deserialize(), GetEc(), Print(), Serialize(), and SetEc().
|
private |
Encryption Key Sequence.
Definition at line 227 of file wimax-mac-header.h.
Referenced by Deserialize(), GetEks(), Print(), Serialize(), and SetEks().
|
private |
ESF.
Definition at line 225 of file wimax-mac-header.h.
Referenced by GenericMacHeader(), Deserialize(), and Serialize().
|
private |
Header Check Sequence.
Definition at line 231 of file wimax-mac-header.h.
Referenced by GenericMacHeader(), check_hcs(), Deserialize(), GetHcs(), Print(), and SetHcs().
|
private |
Header type.
Definition at line 222 of file wimax-mac-header.h.
Referenced by Deserialize(), GetHt(), Serialize(), and SetHt().
|
private |
length
Definition at line 229 of file wimax-mac-header.h.
Referenced by Deserialize(), GetLen(), Print(), Serialize(), and SetLen().
|
private |
RSV.
Definition at line 228 of file wimax-mac-header.h.
Referenced by GenericMacHeader(), Deserialize(), and Serialize().
|
private |
type
Definition at line 224 of file wimax-mac-header.h.
Referenced by Deserialize(), GetType(), Print(), Serialize(), and SetType().