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

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

#include <uan-header-rc.h>

+ Inheritance diagram for ns3::UanHeaderRcAck:
+ Collaboration diagram for ns3::UanHeaderRcAck:

Public Member Functions

 UanHeaderRcAck ()
 Default constructor. More...
 
virtual ~UanHeaderRcAck ()
 Destructor. More...
 
void AddNackedFrame (uint8_t frame)
 NACK a frame. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
uint8_t GetFrameNo (void) const
 Get the reservation frame number being ACKed. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
const std::set< uint8_t > & GetNackedFrames (void) const
 Get the set of NACK'ed frames. More...
 
uint8_t GetNoNacks (void) const
 Get the number of data frames being NACKed. More...
 
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)
 Set the frame number of the reservation being acknowledged. More...
 
- 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)
 Register this type. 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

uint8_t m_frameNo
 Next frame number. More...
 
std::set< uint8_t > m_nackedFrames
 Marker for nacked frames. More...
 

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

Header used for ACK packets by protocol 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 430 of file uan-header-rc.h.

Constructor & Destructor Documentation

ns3::UanHeaderRcAck::UanHeaderRcAck ( )

Default constructor.

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

ns3::UanHeaderRcAck::~UanHeaderRcAck ( )
virtual

Destructor.

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

References m_nackedFrames.

Member Function Documentation

void ns3::UanHeaderRcAck::AddNackedFrame ( uint8_t  frame)

NACK a frame.

Parameters
frameThe data frame number being NACKed.

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

References m_nackedFrames.

Referenced by ns3::UanMacRcGw::EndCycle().

+ Here is the caller graph for this function:

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(), m_frameNo, m_nackedFrames, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

uint8_t ns3::UanHeaderRcAck::GetFrameNo ( void  ) const

Get the reservation frame number being ACKed.

Returns
The frame number.

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

References m_frameNo.

Referenced by ns3::UanMacRc::ProcessAck().

+ Here is the caller graph for this function:

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.

References GetTypeId().

+ Here is the call graph for this function:

const std::set< uint8_t > & ns3::UanHeaderRcAck::GetNackedFrames ( void  ) const

Get the set of NACK'ed frames.

Returns
The set of NACK'ed frames.

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

References m_nackedFrames.

Referenced by ns3::UanMacRc::ProcessAck().

+ Here is the caller graph for this function:

uint8_t ns3::UanHeaderRcAck::GetNoNacks ( void  ) const

Get the number of data frames being NACKed.

Returns
The number of NACKed frames.

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

References m_nackedFrames.

Referenced by GetSerializedSize(), Print(), ns3::UanMacRc::ProcessAck(), and Serialize().

+ Here is the caller graph for this function:

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().

Referenced by ns3::UanMacRcGw::UanMacRcGw().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

TypeId ns3::UanHeaderRcAck::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 536 of file uan-header-rc.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::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(), m_frameNo, and m_nackedFrames.

+ Here is the call graph for this function:

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(), m_frameNo, m_nackedFrames, and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::UanHeaderRcAck::SetFrameNo ( uint8_t  frameNo)

Set the frame number of the reservation being acknowledged.

Parameters
frameNoThe frame number.

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

References m_frameNo.

Referenced by ns3::UanMacRcGw::EndCycle().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::UanHeaderRcAck::m_frameNo
private

Next frame number.

Definition at line 484 of file uan-header-rc.h.

Referenced by Deserialize(), GetFrameNo(), Print(), Serialize(), and SetFrameNo().

std::set<uint8_t> ns3::UanHeaderRcAck::m_nackedFrames
private

Marker for nacked frames.

Definition at line 485 of file uan-header-rc.h.

Referenced by AddNackedFrame(), Deserialize(), GetNackedFrames(), GetNoNacks(), Print(), Serialize(), and ~UanHeaderRcAck().


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