tid-to-link-mapping-element.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022
 *
 * 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
 *
 * Author: Sharan Naribole <sharan.naribole@gmail.com>
 */
 
#ifndef TID_TO_LINK_MAPPING_H
#define TID_TO_LINK_MAPPING_H
 
#include "ns3/nstime.h"
#include "ns3/wifi-information-element.h"
#include "ns3/wifi-utils.h"
 
#include <map>
#include <optional>
#include <set>
 
namespace ns3
{
 
/// whether to enforce the default link mapping
constexpr auto DEFAULT_WIFI_TID_LINK_MAPPING{true};
/// default value for the Direction subfield of the TID-To-Link Control field
constexpr auto DEFAULT_WIFI_TID_LINK_MAP_DIR{WifiDirection::BOTH_DIRECTIONS};
/// size in bytes of the TID-To-Link Control field with default link mapping
constexpr uint16_t WIFI_TID_TO_LINK_MAPPING_CONTROL_BASIC_SIZE_B =
    1; // IEEE 802.11be D2.0 9.4.2.314
/// size in bytes of the Link Mapping Presence Indicator field (IEEE 802.11be D2.0 9.4.2.314)
constexpr uint16_t WIFI_LINK_MAPPING_PRESENCE_IND_SIZE_B = 1;
 
/**
 * \brief TID-to-Link Mapping Information Element
 * \ingroup wifi
 *
 * This class serializes and deserializes
 * the TID-to-Link Mapping element
 * IEEE 802.11be D3.1 9.4.2.314
 *
 */
class TidToLinkMapping : public WifiInformationElement
{
  public:
    /**
     * TID-to-Link Mapping Control subfield
     * IEEE 802.11be D3.1 Figure 9-1002ap
     */
    struct Control
    {
        friend class TidToLinkMapping;
 
        WifiDirection direction{DEFAULT_WIFI_TID_LINK_MAP_DIR}; ///< Direction
        bool defaultMapping{DEFAULT_WIFI_TID_LINK_MAPPING};     ///< Default link mapping
 
        /// \return Serialized size of TID-to-Link Mapping Control in octets
        uint16_t GetSubfieldSize() const;
 
        /**
         * Serialize the TID-to-Link Mapping Control subfield
         *
         * \param start iterator pointing to where the subfield should be written to
         */
        void Serialize(Buffer::Iterator& start) const;
        /**
         * Deserialize the TID-to-Link Mapping Control subfield
         *
         * \param start iterator pointing to where the subfield should be read from
         * \return the number of octets read
         */
        uint16_t Deserialize(Buffer::Iterator start);
 
      private:
        /**
         * These members are private to prevent users to manipulate them directly (their values
         * depend on the values of other fields)
         */
        bool mappingSwitchTimePresent{false}; ///< Mapping Switch Time Present
        bool expectedDurationPresent{false};  ///< Expected Duration Present
        uint8_t linkMappingSize{1}; ///< length of the Link Mapping Of TID n field in octets
        std::optional<uint8_t> presenceBitmap; ///< Link Mapping Presence Indicator
    };
 
    WifiInformationElementId ElementId() const override;
    WifiInformationElementId ElementIdExt() const override;
 
    /**
     * Set the Mapping Switch Time field.
     *
     * \param mappingSwitchTime the time when the new mapping is established (rounded to a
     *                          multiple of a TU)
     */
    void SetMappingSwitchTime(Time mappingSwitchTime);
 
    /// \return the value of the Mapping Switch Time field, if present.
    std::optional<Time> GetMappingSwitchTime() const;
 
    /**
     * Set the Expected Duration field.
     *
     * \param expectedDuration the value for the Expected Duration field (rounded to a
     *                         multiple of a TU)
     */
    void SetExpectedDuration(Time expectedDuration);
 
    /// \return the value of the Expected Duration field, if present.
    std::optional<Time> GetExpectedDuration() const;
 
    /**
     * Set the Link Mapping field of the given TID such that the given TID is mapped
     * to the links associated with the given link IDs.
     *
     * \param tid the given TID
     * \param linkIds the IDs of the links which the given TID is mapped to
     */
    void SetLinkMappingOfTid(uint8_t tid, std::set<uint8_t> linkIds);
    /**
     * Get the Link Mapping field of the given TID.
     *
     * \param tid the given TID
     * \return the IDs of the links which the given TID is mapped to
     */
    std::set<uint8_t> GetLinkMappingOfTid(uint8_t tid) const;
 
    TidToLinkMapping::Control m_control;       ///< TID-to-link Mapping Control
    std::map<uint8_t, uint16_t> m_linkMapping; ///< TID-indexed Link Mapping
 
  private:
    std::optional<uint16_t> m_mappingSwitchTime; ///< Mapping Switch Time
    std::optional<uint32_t> m_expectedDuration;  ///< Expected Duration
 
    uint16_t GetInformationFieldSize() const override;
    void SerializeInformationField(Buffer::Iterator start) const override;
    uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override;
};
 
} // namespace ns3
 
#endif /* TID_TO_LINK_MAPPING_H */