ns3::MacHeaderType Class Reference

Represents the HT (Header Type) field of generic MAC and bandwidth request headers. More...

#include <wimax-mac-header.h>

Inheritance diagram for ns3::MacHeaderType:

Collaboration diagram for ns3::MacHeaderType:

Public Types
enum	HeaderType { HEADER_TYPE_GENERIC, HEADER_TYPE_BANDWIDTH }
	this class implements the mac header type field. More...

Public Member Functions
	MacHeaderType (void)
	MacHeaderType (uint8_t type)
virtual	~MacHeaderType (void)
uint32_t	Deserialize (Buffer::Iterator start)
virtual TypeId	GetInstanceTypeId (void) const
std::string	GetName (void) const
uint32_t	GetSerializedSize (void) const
uint8_t	GetType (void) const
void	Print (std::ostream &os) const
void	Serialize (Buffer::Iterator start) const
void	SetType (uint8_t type)
Public Member Functions inherited from ns3::Header
virtual	~Header ()
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
uint8_t	m_type

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Represents the HT (Header Type) field of generic MAC and bandwidth request headers.

Doxygen introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 34 of file wimax-mac-header.h.

Member Enumeration Documentation

enum ns3::MacHeaderType::HeaderType

this class implements the mac header type field.

See also

GenericMacHeader

BandwidthRequestHeader

Enumerator
HEADER_TYPE_GENERIC
HEADER_TYPE_BANDWIDTH

Definition at line 42 of file wimax-mac-header.h.

Constructor & Destructor Documentation

ns3::MacHeaderType::MacHeaderType

(

void

)

Definition at line 31 of file wimax-mac-header.cc.

ns3::MacHeaderType::MacHeaderType

(

uint8_t

type

)

Definition at line 36 of file wimax-mac-header.cc.

ns3::MacHeaderType::~MacHeaderType ( void  )

virtual

Definition at line 41 of file wimax-mac-header.cc.

Member Function Documentation

uint32_t ns3::MacHeaderType::Deserialize ( Buffer::Iterator  start )

virtual

Parameters

start

an iterator which points to where the header should written.

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.

Implements ns3::Header.

Definition at line 89 of file wimax-mac-header.cc.

TypeId ns3::MacHeaderType::GetInstanceTypeId ( void  ) const

virtual

Returns

the TypeId associated to the most-derived type of this instance.

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 70 of file wimax-mac-header.cc.

References GetTypeId().

Here is the call graph for this function:

std::string ns3::MacHeaderType::GetName

(

void

)

const

Definition at line 58 of file wimax-mac-header.cc.

uint32_t ns3::MacHeaderType::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 80 of file wimax-mac-header.cc.

Referenced by ns3::WimaxMacQueue::Dequeue(), and ns3::WimaxMacQueue::GetFirstPacketHdrSize().

Here is the caller graph for this function:

uint8_t ns3::MacHeaderType::GetType

(

void

)

const

Definition at line 52 of file wimax-mac-header.cc.

References m_type.

Referenced by ns3::WimaxMacQueue::CheckForFragmentation(), ns3::WimaxMacQueue::Dequeue(), ns3::WimaxMacQueue::Enqueue(), ns3::SubscriberStationNetDevice::Enqueue(), ns3::WimaxMacQueue::Front(), ns3::WimaxMacQueue::GetFirstPacketHdrSize(), ns3::WimaxMacQueue::GetFirstPacketPayloadSize(), ns3::WimaxMacQueue::Peek(), and ns3::WimaxMacQueue::Pop().

Here is the caller graph for this function:

TypeId ns3::MacHeaderType::GetTypeId ( void  )

static

Definition at line 64 of file wimax-mac-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:

void ns3::MacHeaderType::Print ( std::ostream &  os ) const

virtual

Parameters

os

output 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::Header.

Definition at line 75 of file wimax-mac-header.cc.

References m_type.

void ns3::MacHeaderType::Serialize ( Buffer::Iterator  start ) const

virtual

Parameters

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 85 of file wimax-mac-header.cc.

void ns3::MacHeaderType::SetType

(

uint8_t

type

)

Definition at line 46 of file wimax-mac-header.cc.

References m_type.

Member Data Documentation

uint8_t ns3::MacHeaderType::m_type

private

Definition at line 61 of file wimax-mac-header.h.

Referenced by GetType(), Print(), and SetType().

---

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

• src/wimax/model/wimax-mac-header.h
• src/wimax/model/wimax-mac-header.cc