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

See IEEE 802.11-2007 chapter 7.3.1.11 and 7.4.5 also IEEE 802.11p-2010 chapter 7.4.5 Although WifiActionHeader has been defined in wifi mgt-header.h/.cc, it is not a good way to inherit from it or add vendor specific action support. More...

#include <vendor-specific-action.h>

+ Inheritance diagram for ns3::VendorSpecificActionHeader:
+ Collaboration diagram for ns3::VendorSpecificActionHeader:

Public Member Functions

 VendorSpecificActionHeader (void)
 
virtual ~VendorSpecificActionHeader (void)
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
uint8_t GetCategory () const
 the category field shall be CATEGORY_OF_VSA More...
 
virtual TypeId GetInstanceTypeId (void) const
 
OrganizationIdentifier GetOrganizationIdentifier (void) const
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetOrganizationIdentifier (OrganizationIdentifier oi)
 
- 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)
 
- 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_category
 
OrganizationIdentifier m_oi
 

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

See IEEE 802.11-2007 chapter 7.3.1.11 and 7.4.5 also IEEE 802.11p-2010 chapter 7.4.5 Although WifiActionHeader has been defined in wifi mgt-header.h/.cc, it is not a good way to inherit from it or add vendor specific action support.

Doxygen introspection did not find any typical Config paths.

The reason is Action field. Other Action frames contains Action field, and the VSA frame contains OUI or variable OrganizationIdentifier instead of one byte Action field. Header format: | Category | Organization IdentifierType | Vendor Specific content | Octets: 1 j Variable

In ns-3, VSA frame will be divided into VendorSpecificActionHeader vsaHeader and Packet vsc that indicates vendor specific content.

This frame is used by IEEE 1609.4 to send WSA packet of IEEE 1609.3, and if users want to send management information without customized management frames, he can use VSA frames.


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

Definition at line 125 of file vendor-specific-action.h.

Constructor & Destructor Documentation

ns3::VendorSpecificActionHeader::VendorSpecificActionHeader ( void  )

Definition at line 219 of file vendor-specific-action.cc.

References NS_LOG_FUNCTION.

ns3::VendorSpecificActionHeader::~VendorSpecificActionHeader ( void  )
virtual

Definition at line 226 of file vendor-specific-action.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::VendorSpecificActionHeader::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 296 of file vendor-specific-action.cc.

References ns3::CATEGORY_OF_VSA, ns3::OrganizationIdentifier::Deserialize(), GetSerializedSize(), m_category, m_oi, NS_LOG_FUNCTION, and ns3::Buffer::Iterator::ReadU8().

+ Here is the call graph for this function:

uint8_t ns3::VendorSpecificActionHeader::GetCategory ( void  ) const

the category field shall be CATEGORY_OF_VSA

Definition at line 257 of file vendor-specific-action.cc.

References m_category, and NS_LOG_FUNCTION.

Referenced by ns3::OcbWifiMac::Receive().

+ Here is the caller graph for this function:

TypeId ns3::VendorSpecificActionHeader::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 264 of file vendor-specific-action.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

OrganizationIdentifier ns3::VendorSpecificActionHeader::GetOrganizationIdentifier ( void  ) const
Returns
current OrganizationIdentifier of the VSA header

Definition at line 239 of file vendor-specific-action.cc.

References m_oi, and NS_LOG_FUNCTION.

Referenced by ns3::OcbWifiMac::Receive().

+ Here is the caller graph for this function:

uint32_t ns3::VendorSpecificActionHeader::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 281 of file vendor-specific-action.cc.

References ns3::OrganizationIdentifier::GetSerializedSize(), m_category, m_oi, and NS_LOG_FUNCTION.

Referenced by Deserialize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 246 of file vendor-specific-action.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::VendorSpecificActionHeader::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 271 of file vendor-specific-action.cc.

References m_category, m_oi, and NS_LOG_FUNCTION.

void ns3::VendorSpecificActionHeader::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 288 of file vendor-specific-action.cc.

References m_category, m_oi, NS_LOG_FUNCTION, ns3::OrganizationIdentifier::Serialize(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::VendorSpecificActionHeader::SetOrganizationIdentifier ( OrganizationIdentifier  oi)
Parameters
oithe OrganizationIdentifier of current VSA header

Definition at line 232 of file vendor-specific-action.cc.

References m_oi, and NS_LOG_FUNCTION.

Referenced by ns3::OcbWifiMac::SendVsc().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::VendorSpecificActionHeader::m_category
private
OrganizationIdentifier ns3::VendorSpecificActionHeader::m_oi
private

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