This class implements the bandwidth-request 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.2 Bandwidth request header, page 38. More...
#include "wimax-mac-header.h"
Public Types | |
enum | HeaderType { HEADER_TYPE_INCREMENTAL , HEADER_TYPE_AGGREGATE } |
Header type enumeration. More... | |
Public Member Functions | |
BandwidthRequestHeader () | |
~BandwidthRequestHeader () override | |
bool | check_hcs () const |
Check HCS. | |
uint32_t | Deserialize (Buffer::Iterator start) override |
uint32_t | GetBr () const |
Get BR field. | |
Cid | GetCid () const |
Get CID field. | |
uint8_t | GetEc () const |
Get EC 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. | |
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 | SetBr (uint32_t br) |
Set BR field. | |
void | SetCid (Cid cid) |
Set CID field. | |
void | SetEc (uint8_t ec) |
Set EC field. | |
void | SetHcs (uint8_t hcs) |
Set HCS field. | |
void | SetHt (uint8_t ht) |
Set HT field. | |
void | SetType (uint8_t type) |
Set type 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 | |
uint8_t | c_hcs |
calculated header check sequence; this is used to check if the received header is correct or not | |
uint32_t | m_br |
Bandwidth Request. | |
Cid | m_cid |
Connection identifier. | |
uint8_t | m_ec |
Encryption Control. | |
uint8_t | m_hcs |
Header Check Sequence. | |
uint8_t | m_ht |
Header type. | |
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 Symbols 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 bandwidth-request 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.2 Bandwidth request header, page 38.
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wimax
Size of this type is 24 bytes (on a 64-bit architecture).
Definition at line 248 of file wimax-mac-header.h.
Header type enumeration.
Enumerator | |
---|---|
HEADER_TYPE_INCREMENTAL | |
HEADER_TYPE_AGGREGATE |
Definition at line 252 of file wimax-mac-header.h.
ns3::BandwidthRequestHeader::BandwidthRequestHeader | ( | ) |
Definition at line 324 of file wimax-mac-header.cc.
|
override |
Definition at line 334 of file wimax-mac-header.cc.
bool ns3::BandwidthRequestHeader::check_hcs | ( | ) | const |
Check HCS.
Definition at line 517 of file wimax-mac-header.cc.
Referenced by ns3::BaseStationNetDevice::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 481 of file wimax-mac-header.cc.
References c_hcs, ns3::CRC8Calculate(), ns3::Buffer::Iterator::GetDistanceFrom(), m_br, m_cid, m_ec, m_hcs, m_ht, m_type, and ns3::Buffer::Iterator::ReadU8().
uint32_t ns3::BandwidthRequestHeader::GetBr | ( | ) | const |
Get BR field.
Definition at line 393 of file wimax-mac-header.cc.
References m_br.
Referenced by ns3::BandwidthManager::ProcessBandwidthRequest(), and ns3::UplinkSchedulerMBQoS::ProcessBandwidthRequest().
Cid ns3::BandwidthRequestHeader::GetCid | ( | ) | const |
Get CID field.
Definition at line 399 of file wimax-mac-header.cc.
References m_cid.
Referenced by ns3::BaseStationNetDevice::DoReceive(), ns3::BandwidthManager::ProcessBandwidthRequest(), and ns3::UplinkSchedulerMBQoS::ProcessBandwidthRequest().
uint8_t ns3::BandwidthRequestHeader::GetEc | ( | ) | const |
uint8_t ns3::BandwidthRequestHeader::GetHcs | ( | ) | const |
uint8_t ns3::BandwidthRequestHeader::GetHt | ( | ) | const |
Get HT field.
Definition at line 375 of file wimax-mac-header.cc.
References m_ht.
Referenced by ns3::BaseStationNetDevice::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 427 of file wimax-mac-header.cc.
References GetTypeId().
std::string ns3::BandwidthRequestHeader::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 442 of file wimax-mac-header.cc.
uint8_t ns3::BandwidthRequestHeader::GetType | ( | ) | const |
Get type field.
Definition at line 387 of file wimax-mac-header.cc.
References m_type.
Referenced by ns3::BandwidthManager::ProcessBandwidthRequest().
|
static |
Get the type ID.
Definition at line 417 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 433 of file wimax-mac-header.cc.
References ns3::Cid::GetIdentifier(), m_br, m_cid, m_ec, m_hcs, 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 451 of file wimax-mac-header.cc.
References ns3::CRC8Calculate(), ns3::Cid::GetIdentifier(), m_br, m_cid, m_ec, m_ht, m_type, and ns3::Buffer::Iterator::WriteU8().
void ns3::BandwidthRequestHeader::SetBr | ( | uint32_t | br | ) |
Set BR field.
br | the BR |
Definition at line 357 of file wimax-mac-header.cc.
References m_br.
Referenced by ns3::BandwidthManager::SendBandwidthRequest().
void ns3::BandwidthRequestHeader::SetCid | ( | Cid | cid | ) |
Set CID field.
cid | the CID |
Definition at line 363 of file wimax-mac-header.cc.
References m_cid.
Referenced by ns3::BandwidthManager::SendBandwidthRequest().
void ns3::BandwidthRequestHeader::SetEc | ( | uint8_t | ec | ) |
Set EC field.
ec | the EC |
Definition at line 345 of file wimax-mac-header.cc.
References m_ec.
void ns3::BandwidthRequestHeader::SetHcs | ( | uint8_t | hcs | ) |
Set HCS field.
hcs | the HCS |
Definition at line 369 of file wimax-mac-header.cc.
References m_hcs.
void ns3::BandwidthRequestHeader::SetHt | ( | uint8_t | ht | ) |
Set HT field.
ht | the HT |
Definition at line 339 of file wimax-mac-header.cc.
References m_ht.
void ns3::BandwidthRequestHeader::SetType | ( | uint8_t | type | ) |
Set type field.
type | the type |
Definition at line 351 of file wimax-mac-header.cc.
References m_type.
Referenced by ns3::BandwidthManager::SendBandwidthRequest().
|
private |
calculated header check sequence; this is used to check if the received header is correct or not
Definition at line 351 of file wimax-mac-header.h.
Referenced by check_hcs(), and Deserialize().
|
private |
Bandwidth Request.
Definition at line 348 of file wimax-mac-header.h.
Referenced by Deserialize(), GetBr(), Print(), Serialize(), and SetBr().
|
private |
Connection identifier.
Definition at line 349 of file wimax-mac-header.h.
Referenced by Deserialize(), GetCid(), Print(), Serialize(), and SetCid().
|
private |
Encryption Control.
Definition at line 346 of file wimax-mac-header.h.
Referenced by Deserialize(), GetEc(), Print(), Serialize(), and SetEc().
|
private |
Header Check Sequence.
Definition at line 350 of file wimax-mac-header.h.
Referenced by check_hcs(), Deserialize(), GetHcs(), Print(), and SetHcs().
|
private |
Header type.
Definition at line 345 of file wimax-mac-header.h.
Referenced by Deserialize(), GetHt(), Serialize(), and SetHt().
|
private |
type
Definition at line 347 of file wimax-mac-header.h.
Referenced by Deserialize(), GetType(), Print(), Serialize(), and SetType().