A Discrete-Event Network Simulator
API
vendor-specific-action.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013 Dalian University of Technology
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Junling Bu <linlinjavaer@gmail.com>
18  */
19 #ifndef Vendor_Specific_Action_H
20 #define Vendor_Specific_Action_H
21 
22 #include <ostream>
23 #include <map>
24 #include "ns3/header.h"
25 #include "ns3/packet.h"
26 #include "ns3/pointer.h"
27 #include "ns3/attribute.h"
28 #include "ns3/attribute-helper.h"
29 #include "ns3/address.h"
30 
31 namespace ns3 {
32 
33 class WifiMac;
34 class VendorSpecificContentManager;
35 
54 {
55 public:
63  OrganizationIdentifier (const uint8_t *str, uint32_t length);
66  virtual ~OrganizationIdentifier (void);
67 
70  {
71  OUI24 = 3, // 3 bytes
72  OUI36 = 5, // 5 bytes
73  Unknown = 0,
74  };
75 
79  uint8_t GetManagementId (void) const;
83  bool IsNull (void) const;
87  void SetType (enum OrganizationIdentifierType type);
91  enum OrganizationIdentifierType GetType (void) const;
92 
93  // below methods will be called by VendorSpecificActionHeader
98  uint32_t GetSerializedSize (void) const;
103  void Serialize (Buffer::Iterator start) const;
110 
111 private:
112  friend bool operator == (const OrganizationIdentifier& a, const OrganizationIdentifier& b);
113  friend bool operator != (const OrganizationIdentifier& a, const OrganizationIdentifier& b);
114  friend bool operator < (const OrganizationIdentifier& a, const OrganizationIdentifier& b);
115  friend std::ostream& operator << (std::ostream& os, const OrganizationIdentifier& oi);
116  friend std::istream& operator >> (std::istream& is, const OrganizationIdentifier& oi);
117 
119  uint8_t m_oi[5];
120 };
121 
123 
127 
128 std::ostream& operator << (std::ostream& os, const OrganizationIdentifier& oi);
129 std::istream& operator >> (std::istream& is, const OrganizationIdentifier& oi);
130 
135 const static uint8_t CATEGORY_OF_VSA = 127;
136 
156 {
157 public:
159  virtual ~VendorSpecificActionHeader (void);
160 
172  uint8_t GetCategory (void) const;
173 
178  static TypeId GetTypeId (void);
179  virtual TypeId GetInstanceTypeId (void) const;
180  virtual void Print (std::ostream &os) const;
181  virtual uint32_t GetSerializedSize (void) const;
182  virtual void Serialize (Buffer::Iterator start) const;
183  virtual uint32_t Deserialize (Buffer::Iterator start);
184 
185 private:
187  uint8_t m_category;
188 };
189 
199 
206 {
207 public:
209  virtual ~VendorSpecificContentManager (void);
233 
234 private:
236  typedef std::map<OrganizationIdentifier,VscCallback> VscCallbacks;
238  typedef std::map<OrganizationIdentifier,VscCallback>::iterator VscCallbacksI;
239 
241 };
242 
243 static std::vector<OrganizationIdentifier> OrganizationIdentifiers;
244 }
245 
246 #endif /* Vendor_Specific_Action_H */
Protocol header serialization and deserialization.
Definition: header.h:42
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:48
Callback template class.
Definition: callback.h:1273
void RegisterVscCallback(OrganizationIdentifier oi, VscCallback cb)
friend std::istream & operator>>(std::istream &is, const OrganizationIdentifier &oi)
input operator
virtual void Print(std::ostream &os) const
friend bool operator<(const OrganizationIdentifier &a, const OrganizationIdentifier &b)
less than operator
uint32_t Deserialize(Buffer::Iterator start)
Deserialize from buffer.
def start()
Definition: core.py:1855
std::map< OrganizationIdentifier, VscCallback > VscCallbacks
VSC callback typedef.
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.
enum OrganizationIdentifierType GetType(void) const
void SetType(enum OrganizationIdentifierType type)
iterator in a Buffer instance
Definition: buffer.h:98
a polymophic address class
Definition: address.h:90
void DeregisterVscCallback(OrganizationIdentifier &oi)
bool operator<(const EventId &a, const EventId &b)
Definition: event-id.h:155
uint8_t m_oi[5]
organization identifier
VscCallbacks m_callbacks
VSC callbacks.
VendorSpecificContentManager class.
uint8_t GetCategory(void) const
the category field shall be CATEGORY_OF_VSA
friend bool operator==(const OrganizationIdentifier &a, const OrganizationIdentifier &b)
equality operator
void SetOrganizationIdentifier(OrganizationIdentifier oi)
the organization identifier is a public organizationally unique identifier assigned by the IEEE...
friend std::ostream & operator<<(std::ostream &os, const OrganizationIdentifier &oi)
output operator
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
bool operator!=(Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > a, Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > b)
Inequality test.
Definition: callback.h:1592
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void Serialize(Buffer::Iterator start) const
Callback< bool, Ptr< WifiMac >, const OrganizationIdentifier &, Ptr< const Packet >, const Address & > VscCallback
bool IsVscCallbackRegistered(OrganizationIdentifier &oi)
OrganizationIdentifier & operator=(const OrganizationIdentifier &oi)
assignment operator
VscCallback FindVscCallback(OrganizationIdentifier &oi)
static const uint8_t CATEGORY_OF_VSA
see IEEE 802.11-2007 chapter 7.3.1.11 Table 7-24—Category values
uint32_t GetSerializedSize(void) const
Get serialized size.
OrganizationIdentifier GetOrganizationIdentifier(void) const
static std::vector< OrganizationIdentifier > OrganizationIdentifiers
the OIs
virtual uint32_t GetSerializedSize(void) const
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.h:137
OrganizationIdentifierType
OrganizationIdentifierType enumeration.
friend bool operator!=(const OrganizationIdentifier &a, const OrganizationIdentifier &b)
inequality operator
static TypeId GetTypeId(void)
Get the type ID.
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
void Serialize(Buffer::Iterator start) const
Serialize to buffer.
a unique identifier for an interface.
Definition: type-id.h:58
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type
enum OrganizationIdentifierType m_type
OI type.
std::map< OrganizationIdentifier, VscCallback >::iterator VscCallbacksI
VSC callback iterator typedef.
virtual uint32_t Deserialize(Buffer::Iterator start)