Public Member Functions | Static Public Member Functions

ns3::UanHeaderCommon Class Reference

#include <uan-header-common.h>

Inheritance diagram for ns3::UanHeaderCommon:
Inheritance graph
[legend]
Collaboration diagram for ns3::UanHeaderCommon:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 UanHeaderCommon (const UanAddress src, const UanAddress dest, uint8_t type)
 Create UanHeaderCommon object with given source and destination address and header type.
void SetDest (UanAddress dest)
void SetSrc (UanAddress src)
void SetType (uint8_t type)
UanAddress GetDest (void) const
UanAddress GetSrc (void) const
uint8_t GetType (void) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (Buffer::Iterator start) const
virtual uint32_t Deserialize (Buffer::Iterator start)
virtual void Print (std::ostream &os) const
virtual TypeId GetInstanceTypeId (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::UanHeaderCommon.

Detailed Description

Header includes 1 byte src address, 1 byte dest address, and a 1 byte type field.


Constructor & Destructor Documentation

ns3::UanHeaderCommon::UanHeaderCommon ( const UanAddress  src,
const UanAddress  dest,
uint8_t  type 
)

Create UanHeaderCommon object with given source and destination address and header type.

Parameters:
src Source address defined in header
dest Destination address defined in header
type Header type

Member Function Documentation

virtual uint32_t ns3::UanHeaderCommon::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.

UanAddress ns3::UanHeaderCommon::GetDest ( void   )  const
Returns:
UanAddress in destination field
virtual TypeId ns3::UanHeaderCommon::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.

virtual uint32_t ns3::UanHeaderCommon::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.

UanAddress ns3::UanHeaderCommon::GetSrc ( void   )  const
Returns:
UanAddress in source field
uint8_t ns3::UanHeaderCommon::GetType ( void   )  const
Returns:
value of type field
static TypeId ns3::UanHeaderCommon::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::UanHeaderCommon.

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

Reimplemented from ns3::Header.

virtual void ns3::UanHeaderCommon::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.

virtual void ns3::UanHeaderCommon::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.

void ns3::UanHeaderCommon::SetDest ( UanAddress  dest  ) 
Parameters:
dest Address of destination node
void ns3::UanHeaderCommon::SetSrc ( UanAddress  src  ) 
Parameters:
src Address of packet source node
void ns3::UanHeaderCommon::SetType ( uint8_t  type  ) 
Parameters:
type Value to set 1 byte type field to. Value has protocol specific meaning

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