vendor-specific-action.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Dalian University of Technology
 * 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: Junling Bu <linlinjavaer@gmail.com>
 */
#ifndef Vendor_Specific_Action_H
#define Vendor_Specific_Action_H
 
#include "ns3/address.h"
#include "ns3/attribute-helper.h"
#include "ns3/attribute.h"
#include "ns3/header.h"
#include "ns3/packet.h"
#include "ns3/pointer.h"
 
#include <map>
#include <ostream>
 
namespace ns3
{
 
class WifiMac;
class VendorSpecificContentManager;
 
class OrganizationIdentifier
{
  public:
    OrganizationIdentifier();
    OrganizationIdentifier(const uint8_t* str, uint32_t length);
    OrganizationIdentifier& operator=(const OrganizationIdentifier& oi);
    virtual ~OrganizationIdentifier();
 
    enum OrganizationIdentifierType
    {
        OUI24 = 3, // 3 bytes
        OUI36 = 5, // 5 bytes
        Unknown = 0,
    };
 
    uint8_t GetManagementId() const;
    bool IsNull() const;
    void SetType(OrganizationIdentifierType type);
    OrganizationIdentifierType GetType() const;
 
    // below methods will be called by VendorSpecificActionHeader
    uint32_t GetSerializedSize() const;
    void Serialize(Buffer::Iterator start) const;
    uint32_t Deserialize(Buffer::Iterator start);
 
  private:
    friend bool operator==(const OrganizationIdentifier& a, const OrganizationIdentifier& b);
    friend bool operator!=(const OrganizationIdentifier& a, const OrganizationIdentifier& b);
    friend bool operator<(const OrganizationIdentifier& a, const OrganizationIdentifier& b);
    friend std::ostream& operator<<(std::ostream& os, const OrganizationIdentifier& oi);
    friend std::istream& operator>>(std::istream& is, const OrganizationIdentifier& oi);
 
    OrganizationIdentifierType m_type; 
    uint8_t m_oi[5];                   
};
 
ATTRIBUTE_HELPER_HEADER(OrganizationIdentifier);
 
bool operator==(const OrganizationIdentifier& a, const OrganizationIdentifier& b);
bool operator!=(const OrganizationIdentifier& a, const OrganizationIdentifier& b);
bool operator<(const OrganizationIdentifier& a, const OrganizationIdentifier& b);
 
std::ostream& operator<<(std::ostream& os, const OrganizationIdentifier& oi);
std::istream& operator>>(std::istream& is, const OrganizationIdentifier& oi);
 
const static uint8_t CATEGORY_OF_VSA = 127;
 
class VendorSpecificActionHeader : public Header
{
  public:
    VendorSpecificActionHeader();
    ~VendorSpecificActionHeader() override;
 
    void SetOrganizationIdentifier(OrganizationIdentifier oi);
    OrganizationIdentifier GetOrganizationIdentifier() const;
    uint8_t GetCategory() const;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    void Print(std::ostream& os) const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
 
  private:
    OrganizationIdentifier m_oi; 
    uint8_t m_category;          
};
 
typedef Callback<bool,
                 Ptr<WifiMac>,
                 const OrganizationIdentifier&,
                 Ptr<const Packet>,
                 const Address&>
    VscCallback;
 
class VendorSpecificContentManager
{
  public:
    VendorSpecificContentManager();
    virtual ~VendorSpecificContentManager();
    void RegisterVscCallback(OrganizationIdentifier oi, VscCallback cb);
    void DeregisterVscCallback(OrganizationIdentifier& oi);
    bool IsVscCallbackRegistered(OrganizationIdentifier& oi);
    VscCallback FindVscCallback(OrganizationIdentifier& oi);
 
  private:
    typedef std::map<OrganizationIdentifier, VscCallback> VscCallbacks;
    typedef std::map<OrganizationIdentifier, VscCallback>::iterator VscCallbacksI;
 
    VscCallbacks m_callbacks; 
};
 
static std::vector<OrganizationIdentifier> OrganizationIdentifiers; 
} // namespace ns3
 
#endif /* Vendor_Specific_Action_H */