A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::UanHeaderRcAck Class Reference

Header used for ACK packets by protocol ns3::UanMacRc. More...

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::UanHeaderRcAck:

Public Member Functions

void AddNackedFrame (uint8_t frame)
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
uint8_t GetFrameNo (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
const std::set< uint8_t > & GetNackedFrames (void) const
 
uint8_t GetNoNacks (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetFrameNo (uint8_t frameNo)
 
- Public Member Functions inherited from ns3::ObjectBase
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)
 

Private Attributes

uint8_t m_frameNo
 
std::set< uint8_t > m_nackedFrames
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Header used for ACK packets by protocol ns3::UanMacRc.

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 330 of file uan-header-rc.h.

Member Function Documentation

void ns3::UanHeaderRcAck::AddNackedFrame ( uint8_t  frame)
Parameters
frameData frame # being nacked

Definition at line 552 of file uan-header-rc.cc.

uint32_t ns3::UanHeaderRcAck::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 594 of file uan-header-rc.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), and ns3::Buffer::Iterator::ReadU8().

uint8_t ns3::UanHeaderRcAck::GetFrameNo ( void  ) const
Returns
Reservation frame # being acknowledged.

Definition at line 564 of file uan-header-rc.cc.

TypeId ns3::UanHeaderRcAck::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 624 of file uan-header-rc.cc.

const std::set< uint8_t > & ns3::UanHeaderRcAck::GetNackedFrames ( void  ) const
Returns
Set of nacked frames

Definition at line 558 of file uan-header-rc.cc.

uint8_t ns3::UanHeaderRcAck::GetNoNacks ( void  ) const
Returns
Number of data frames being NACKED

Definition at line 570 of file uan-header-rc.cc.

Referenced by GetSerializedSize(), Print(), and Serialize().

uint32_t ns3::UanHeaderRcAck::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 576 of file uan-header-rc.cc.

References GetNoNacks().

void ns3::UanHeaderRcAck::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 608 of file uan-header-rc.cc.

References GetNoNacks().

void ns3::UanHeaderRcAck::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 582 of file uan-header-rc.cc.

References GetNoNacks(), and ns3::Buffer::Iterator::WriteU8().

void ns3::UanHeaderRcAck::SetFrameNo ( uint8_t  frameNo)
Parameters
frameNoFrame # of reservation being acknowledged

Definition at line 546 of file uan-header-rc.cc.


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