mgt-headers.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2006 INRIA
 * Copyright (c) 2009 MIRKO BANCHI
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Mirko Banchi <mk.banchi@gmail.com>
 */

#ifndef MGT_HEADERS_H
#define MGT_HEADERS_H

#include "ns3/mac48-address.h"
#include "status-code.h"
#include "capability-information.h"
#include "supported-rates.h"
#include "ssid.h"
#include "dsss-parameter-set.h"
#include "extended-capabilities.h"
#include "ht-capabilities.h"
#include "ht-operation.h"
#include "vht-capabilities.h"
#include "vht-operation.h"
#include "erp-information.h"
#include "edca-parameter-set.h"
#include "he-capabilities.h"
#include "he-operation.h"
#include "cf-parameter-set.h"

namespace ns3 {

class MgtAssocRequestHeader : public Header
{
public:
  MgtAssocRequestHeader ();
  ~MgtAssocRequestHeader ();

  void SetSsid (Ssid ssid);
  void SetSupportedRates (SupportedRates rates);
  void SetListenInterval (uint16_t interval);
  void SetCapabilities (CapabilityInformation capabilities);
  void SetExtendedCapabilities (ExtendedCapabilities extendedCapabilities);
  void SetHtCapabilities (HtCapabilities htCapabilities);
  void SetVhtCapabilities (VhtCapabilities vhtCapabilities);
  void SetHeCapabilities (HeCapabilities heCapabilities);
  CapabilityInformation GetCapabilities (void) const;
  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  HeCapabilities GetHeCapabilities (void) const;
  Ssid GetSsid (void) const;
  SupportedRates GetSupportedRates (void) const;
  uint16_t GetListenInterval (void) const;

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);


private:
  Ssid m_ssid;                        
  SupportedRates m_rates;             
  CapabilityInformation m_capability; 
  ExtendedCapabilities m_extendedCapability; 
  HtCapabilities m_htCapability;      
  VhtCapabilities m_vhtCapability;    
  HeCapabilities m_heCapability;      
  uint16_t m_listenInterval;          
};


class MgtReassocRequestHeader : public Header
{
public:
  MgtReassocRequestHeader ();
  ~MgtReassocRequestHeader ();

  void SetSsid (Ssid ssid);
  void SetSupportedRates (SupportedRates rates);
  void SetListenInterval (uint16_t interval);
  void SetCapabilities (CapabilityInformation capabilities);
  void SetExtendedCapabilities (ExtendedCapabilities extendedCapabilities);
  void SetHtCapabilities (HtCapabilities htCapabilities);
  void SetVhtCapabilities (VhtCapabilities vhtCapabilities);
  void SetHeCapabilities (HeCapabilities heCapabilities);
  CapabilityInformation GetCapabilities (void) const;
  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  HeCapabilities GetHeCapabilities (void) const;
  Ssid GetSsid (void) const;
  SupportedRates GetSupportedRates (void) const;
  uint16_t GetListenInterval (void) const;
  void SetCurrentApAddress (Mac48Address currentApAddr);

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);


private:
  Mac48Address m_currentApAddr;       
  Ssid m_ssid;                        
  SupportedRates m_rates;             
  CapabilityInformation m_capability; 
  ExtendedCapabilities m_extendedCapability; 
  HtCapabilities m_htCapability;      
  VhtCapabilities m_vhtCapability;    
  HeCapabilities m_heCapability;      
  uint16_t m_listenInterval;          
};


class MgtAssocResponseHeader : public Header
{
public:
  MgtAssocResponseHeader ();
  ~MgtAssocResponseHeader ();

  StatusCode GetStatusCode (void);
  SupportedRates GetSupportedRates (void);
  CapabilityInformation GetCapabilities (void) const;
  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  HtOperation GetHtOperation (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  VhtOperation GetVhtOperation (void) const;
  HeCapabilities GetHeCapabilities (void) const;
  HeOperation GetHeOperation (void) const;
  uint16_t GetAssociationId (void) const;
  ErpInformation GetErpInformation (void) const;
  EdcaParameterSet GetEdcaParameterSet (void) const;
  void SetCapabilities (CapabilityInformation capabilities);
  void SetExtendedCapabilities (ExtendedCapabilities extendedCapabilities);
  void SetVhtOperation (VhtOperation vhtOperation);
  void SetVhtCapabilities (VhtCapabilities vhtCapabilities);
  void SetHtCapabilities (HtCapabilities htCapabilities);
  void SetHtOperation (HtOperation htOperation);
  void SetSupportedRates (SupportedRates rates);
  void SetStatusCode (StatusCode code);
  void SetAssociationId (uint16_t aid);
  void SetErpInformation (ErpInformation erpInformation);
  void SetEdcaParameterSet (EdcaParameterSet edcaParameterSet);
  void SetHeCapabilities (HeCapabilities heCapabilities);
  void SetHeOperation (HeOperation heOperation);

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);


private:
  SupportedRates m_rates; 
  CapabilityInformation m_capability; 
  StatusCode m_code; 
  uint16_t m_aid; 
  ExtendedCapabilities m_extendedCapability; 
  HtCapabilities m_htCapability; 
  HtOperation m_htOperation; 
  VhtCapabilities m_vhtCapability; 
  VhtOperation m_vhtOperation; 
  ErpInformation m_erpInformation; 
  EdcaParameterSet m_edcaParameterSet; 
  HeCapabilities m_heCapability; 
  HeOperation m_heOperation; 
};


class MgtProbeRequestHeader : public Header
{
public:
  ~MgtProbeRequestHeader ();

  void SetSsid (Ssid ssid);
  void SetSupportedRates (SupportedRates rates);
  void SetExtendedCapabilities (ExtendedCapabilities extendedCapabilities);
  void SetHtCapabilities (HtCapabilities htCapabilities);
  void SetVhtCapabilities (VhtCapabilities vhtCapabilities);
  void SetHeCapabilities (HeCapabilities heCapabilities);
  Ssid GetSsid (void) const;
  SupportedRates GetSupportedRates (void) const;
  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  HeCapabilities GetHeCapabilities (void) const;

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);


private:
  Ssid m_ssid;                     
  SupportedRates m_rates;          
  ExtendedCapabilities m_extendedCapability; 
  HtCapabilities m_htCapability;   
  VhtCapabilities m_vhtCapability; 
  HeCapabilities m_heCapability; 
};


class MgtProbeResponseHeader : public Header
{
public:
  MgtProbeResponseHeader ();
  ~MgtProbeResponseHeader ();

  Ssid GetSsid (void) const;
  uint64_t GetBeaconIntervalUs (void) const;
  SupportedRates GetSupportedRates (void) const;
  CapabilityInformation GetCapabilities (void) const;
  DsssParameterSet GetDsssParameterSet (void) const;
  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  HtOperation GetHtOperation (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  VhtOperation GetVhtOperation (void) const;
  HeCapabilities GetHeCapabilities (void) const;
  HeOperation GetHeOperation (void) const;
  ErpInformation GetErpInformation (void) const;
  EdcaParameterSet GetEdcaParameterSet (void) const;
  CfParameterSet GetCfParameterSet (void) const;
  void SetCapabilities (CapabilityInformation capabilities);
  void SetExtendedCapabilities (ExtendedCapabilities extendedCapabilities);
  void SetHtCapabilities (HtCapabilities htCapabilities);
  void SetHtOperation (HtOperation htOperation);
  void SetVhtCapabilities (VhtCapabilities vhtCapabilities);
  void SetVhtOperation (VhtOperation vhtOperation);
  void SetHeCapabilities (HeCapabilities heCapabilities);
  void SetHeOperation (HeOperation heOperation);
  void SetSsid (Ssid ssid);
  void SetBeaconIntervalUs (uint64_t us);
  void SetSupportedRates (SupportedRates rates);
  void SetDsssParameterSet (DsssParameterSet dsssParameterSet);
  void SetErpInformation (ErpInformation erpInformation);
  void SetEdcaParameterSet (EdcaParameterSet edcaParameterSet);
  void SetCfParameterSet (CfParameterSet cfParameterSet);
  uint64_t GetTimestamp ();

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);


private:
  uint64_t m_timestamp;                
  Ssid m_ssid;                         
  uint64_t m_beaconInterval;           
  SupportedRates m_rates;              
  CapabilityInformation m_capability;  
  DsssParameterSet m_dsssParameterSet; 
  ExtendedCapabilities m_extendedCapability; 
  HtCapabilities m_htCapability;       
  HtOperation m_htOperation;           
  VhtCapabilities m_vhtCapability;     
  VhtOperation m_vhtOperation;         
  HeCapabilities m_heCapability;       
  HeOperation m_heOperation;         
  ErpInformation m_erpInformation;     
  EdcaParameterSet m_edcaParameterSet; 
  CfParameterSet m_cfParameterSet;     
};


class MgtBeaconHeader : public MgtProbeResponseHeader
{
public:
  static TypeId GetTypeId (void);
};


/****************************
*     Action frames
*****************************/

class WifiActionHeader : public Header
{
public:
  WifiActionHeader ();
  ~WifiActionHeader ();

  /*
   * Compatible with table 8-38 IEEE 802.11, Part11, (Year 2012)
   * Category values - see 802.11-2012 Table 8-38
   */

  enum CategoryValue //table 8-38 staring from IEEE 802.11, Part11, (Year 2012)
  {
    BLOCK_ACK = 3,
    MESH = 13,                  //Category: Mesh
    MULTIHOP = 14,              //not used so far
    SELF_PROTECTED = 15,        //Category: Self Protected
    //Since vendor specific action has no stationary Action value,the parse process is not here.
    //Refer to vendor-specific-action in wave module.
    VENDOR_SPECIFIC_ACTION = 127,
  };

  enum SelfProtectedActionValue //Category: 15 (Self Protected)
  {
    PEER_LINK_OPEN = 1,         //Mesh Peering Open
    PEER_LINK_CONFIRM = 2,      //Mesh Peering Confirm
    PEER_LINK_CLOSE = 3,        //Mesh Peering Close
    GROUP_KEY_INFORM = 4,       //Mesh Group Key Inform
    GROUP_KEY_ACK = 5,          //Mesh Group Key Acknowledge
  };

  enum MultihopActionValue
  {
    PROXY_UPDATE = 0,                   //not used so far
    PROXY_UPDATE_CONFIRMATION = 1,      //not used so far
  };

  enum MeshActionValue
  {
    LINK_METRIC_REPORT = 0,               //Action Value:0 in Category 13: Mesh
    PATH_SELECTION = 1,                   //Action Value:1 in Category 13: Mesh
    PORTAL_ANNOUNCEMENT = 2,              //Action Value:2 in Category 13: Mesh
    CONGESTION_CONTROL_NOTIFICATION = 3,  //Action Value:3 in Category 13: Mesh
    MDA_SETUP_REQUEST = 4,                //Action Value:4 in Category 13: Mesh MCCA-Setup-Request (not used so far)
    MDA_SETUP_REPLY = 5,                  //Action Value:5 in Category 13: Mesh MCCA-Setup-Reply (not used so far)
    MDAOP_ADVERTISMENT_REQUEST = 6,       //Action Value:6 in Category 13: Mesh MCCA-Advertisement-Request (not used so far)
    MDAOP_ADVERTISMENTS = 7,              //Action Value:7 in Category 13: Mesh (not used so far)
    MDAOP_SET_TEARDOWN = 8,               //Action Value:8 in Category 13: Mesh (not used so far)
    TBTT_ADJUSTMENT_REQUEST = 9,          //Action Value:9 in Category 13: Mesh (not used so far)
    TBTT_ADJUSTMENT_RESPONSE = 10,        //Action Value:10 in Category 13: Mesh (not used so far)
  };

  enum BlockAckActionValue
  {
    BLOCK_ACK_ADDBA_REQUEST = 0,
    BLOCK_ACK_ADDBA_RESPONSE = 1,
    BLOCK_ACK_DELBA = 2
  };


  typedef union
  {
    MeshActionValue meshAction; 
    MultihopActionValue multihopAction; 
    SelfProtectedActionValue selfProtectedAction; 
    BlockAckActionValue blockAck; 
  } ActionValue; 

  void SetAction (CategoryValue type, ActionValue action);

  CategoryValue GetCategory ();
  ActionValue GetAction ();

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId () const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize () const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);


private:
  std::string CategoryValueToString (CategoryValue value) const;
  std::string SelfProtectedActionValueToString (SelfProtectedActionValue value) const;
  uint8_t m_category; 
  uint8_t m_actionValue; 
};


class MgtAddBaRequestHeader : public Header
{
public:
  MgtAddBaRequestHeader ();

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);

  void SetDelayedBlockAck ();
  void SetImmediateBlockAck ();
  void SetTid (uint8_t tid);
  void SetTimeout (uint16_t timeout);
  void SetBufferSize (uint16_t size);
  void SetStartingSequence (uint16_t seq);
  void SetAmsduSupport (bool supported);

  uint16_t GetStartingSequence (void) const;
  uint8_t GetTid (void) const;
  bool IsImmediateBlockAck (void) const;
  uint16_t GetTimeout (void) const;
  uint16_t GetBufferSize (void) const;
  bool IsAmsduSupported (void) const;

private:
  uint16_t GetParameterSet (void) const;
  void SetParameterSet (uint16_t params);
  uint16_t GetStartingSequenceControl (void) const;
  void SetStartingSequenceControl (uint16_t seqControl);

  uint8_t m_dialogToken;   
  uint8_t m_amsduSupport;  
  uint8_t m_policy;        
  uint8_t m_tid;           
  uint16_t m_bufferSize;   
  uint16_t m_timeoutValue; 
  uint16_t m_startingSeq;  
};


class MgtAddBaResponseHeader : public Header
{
public:
  MgtAddBaResponseHeader ();

  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);

  void SetDelayedBlockAck ();
  void SetImmediateBlockAck ();
  void SetTid (uint8_t tid);
  void SetTimeout (uint16_t timeout);
  void SetBufferSize (uint16_t size);
  void SetStatusCode (StatusCode code);
  void SetAmsduSupport (bool supported);

  StatusCode GetStatusCode (void) const;
  uint8_t GetTid (void) const;
  bool IsImmediateBlockAck (void) const;
  uint16_t GetTimeout (void) const;
  uint16_t GetBufferSize (void) const;
  bool IsAmsduSupported (void) const;


private:
  uint16_t GetParameterSet (void) const;
  void SetParameterSet (uint16_t params);

  uint8_t m_dialogToken;   
  StatusCode m_code;       
  uint8_t m_amsduSupport;  
  uint8_t m_policy;        
  uint8_t m_tid;           
  uint16_t m_bufferSize;   
  uint16_t m_timeoutValue; 
};


class MgtDelBaHeader : public Header
{
public:
  MgtDelBaHeader ();

  static TypeId GetTypeId (void);
  // Inherited
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);

  bool IsByOriginator (void) const;
  uint8_t GetTid (void) const;
  void SetTid (uint8_t tid);
  void SetByOriginator (void);
  void SetByRecipient (void);


private:
  uint16_t GetParameterSet (void) const;
  void SetParameterSet (uint16_t params);

  uint16_t m_initiator; 
  uint16_t m_tid; 
  uint16_t m_reasonCode; 
};

} //namespace ns3

#endif /* MGT_HEADERS_H */