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

This class implements the Type-Len-Value structure channel encodings as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems". More...

#include <wimax-tlv.h>

+ Inheritance diagram for ns3::Tlv:

Public Types

enum  CommonTypes {
  HMAC_TUPLE = 149, MAC_VERSION_ENCODING = 148, CURRENT_TRANSMIT_POWER = 147, DOWNLINK_SERVICE_FLOW = 146,
  UPLINK_SERVICE_FLOW = 145, VENDOR_ID_EMCODING = 144, VENDOR_SPECIFIC_INFORMATION = 143
}
 

Public Member Functions

 Tlv (uint8_t type, uint64_t length, const TlvValue &value)
 
 Tlv (const Tlv &tlv)
 
TlvCopy (void) const
 
TlvValueCopyValue (void) const
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
virtual TypeId GetInstanceTypeId (void) const
 
uint64_t GetLength (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
uint8_t GetSizeOfLen (void) const
 
uint8_t GetType (void) const
 
Tlvoperator= (Tlv const &o)
 
TlvValuePeekValue (void)
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
- 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)
 

Private Attributes

uint64_t m_length
 
uint8_t m_type
 
TlvValuem_value
 

Additional Inherited Members

- 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)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

This class implements the Type-Len-Value structure channel encodings as described by "IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems".

  1. TLV encodings, page 645

Definition at line 64 of file wimax-tlv.h.

Member Function Documentation

uint32_t ns3::Tlv::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 134 of file wimax-tlv.cc.

References NS_ASSERT_MSG, NS_FATAL_ERROR, and ns3::Buffer::Iterator::ReadU8().

Referenced by ns3::DsaReq::Deserialize(), and ns3::DsaRsp::Deserialize().

TypeId ns3::Tlv::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 29 of file wimax-tlv.cc.

uint32_t ns3::Tlv::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 90 of file wimax-tlv.cc.

Referenced by ns3::DsaReq::GetSerializedSize(), and ns3::DsaRsp::GetSerializedSize().

void ns3::Tlv::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 34 of file wimax-tlv.cc.

void ns3::Tlv::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 114 of file wimax-tlv.cc.

References ns3::Buffer::Iterator::WriteU8().

Referenced by ns3::DsaReq::Serialize(), and ns3::DsaRsp::Serialize().


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