this class implements the mac to mac header needed to dump a wimax pcap file The header format was reverse-engineered by looking at existing live pcap traces which could be opened with wireshark i.e., we have no idea where this is coming from. More...

#include "wimax-mac-to-mac-header.h"

Inheritance diagram for ns3::WimaxMacToMacHeader:

Collaboration diagram for ns3::WimaxMacToMacHeader:

Public Member Functions
	WimaxMacToMacHeader ()

	WimaxMacToMacHeader (uint32_t len)
	Constructor. More...

	~WimaxMacToMacHeader ()

uint32_t	Deserialize (Buffer::Iterator start)

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

uint32_t	GetSerializedSize (void) const

uint8_t	GetSizeOfLen (void) const
	Get size of length field. More...

virtual void	Print (std::ostream &os) const

void	Serialize (Buffer::Iterator start) const

Public Member Functions inherited from ns3::Header
virtual	~Header ()

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

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

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

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

Private Attributes
uint32_t	m_len
	length More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

this class implements the mac to mac header needed to dump a wimax pcap file The header format was reverse-engineered by looking at existing live pcap traces which could be opened with wireshark i.e., we have no idea where this is coming from.

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

Definition at line 35 of file wimax-mac-to-mac-header.h.

Constructor & Destructor Documentation

◆ WimaxMacToMacHeader() [1/2]

ns3::WimaxMacToMacHeader::WimaxMacToMacHeader ( void )

Definition at line 29 of file wimax-mac-to-mac-header.cc.

◆ ~WimaxMacToMacHeader()

ns3::WimaxMacToMacHeader::~WimaxMacToMacHeader ( void )

Definition at line 39 of file wimax-mac-to-mac-header.cc.

◆ WimaxMacToMacHeader() [2/2]

ns3::WimaxMacToMacHeader::WimaxMacToMacHeader ( uint32_t len )

Constructor.

Parameters

len length

Definition at line 34 of file wimax-mac-to-mac-header.cc.

Member Function Documentation

◆ Deserialize()

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

virtual

Parameters

start an iterator which points to where the header should read from.

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.

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

◆ GetInstanceTypeId()

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

virtual

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

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::WimaxMacToMacHeader::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 82 of file wimax-mac-to-mac-header.cc.

References GetSizeOfLen().

Here is the call graph for this function:

◆ GetSizeOfLen()

uint8_t ns3::WimaxMacToMacHeader::GetSizeOfLen ( void ) const

Get size of length field.

Returns: the size of length field

Definition at line 64 of file wimax-mac-to-mac-header.cc.

References m_len.

Referenced by GetSerializedSize(), and Serialize().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::WimaxMacToMacHeader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

◆ Print()

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

virtual

Parameters

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

◆ Serialize()

void ns3::WimaxMacToMacHeader::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 97 of file wimax-mac-to-mac-header.cc.

References GetSizeOfLen(), m_len, ns3::Buffer::Iterator::WriteU16(), ns3::Buffer::Iterator::WriteU8(), and zero.

Here is the call graph for this function:

Member Data Documentation

◆ m_len

uint32_t ns3::WimaxMacToMacHeader::m_len

private

length

Definition at line 63 of file wimax-mac-to-mac-header.h.

Referenced by GetSizeOfLen(), and Serialize().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WimaxMacToMacHeader() [1/2]

◆ ~WimaxMacToMacHeader()

◆ WimaxMacToMacHeader() [2/2]

Member Function Documentation

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetSizeOfLen()

◆ GetTypeId()

◆ Print()

◆ Serialize()

Member Data Documentation

◆ m_len