A Discrete-Event Network Simulator
API
ssid.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2006 INRIA
3  *
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18  */
19 
20 #ifndef SSID_H
21 #define SSID_H
22 
24 
25 namespace ns3
26 {
27 
36 {
37  public:
41  Ssid();
47  Ssid(std::string s);
48 
49  // Implementations of pure virtual methods of WifiInformationElement
50  WifiInformationElementId ElementId() const override;
51  void Print(std::ostream& os) const override;
52 
61  bool IsEqual(const Ssid& o) const;
68  bool IsBroadcast() const;
69 
75  char* PeekString() const;
76 
77  private:
78  uint16_t GetInformationFieldSize() const override;
80  uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override;
81 
82  uint8_t m_ssid[33];
83  uint8_t m_length;
84 };
85 
94 std::istream& operator>>(std::istream& is, Ssid& ssid);
95 
97 
98 } // namespace ns3
99 
100 #endif /* SSID_H */
iterator in a Buffer instance
Definition: buffer.h:100
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:36
uint16_t GetInformationFieldSize() const override
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
Definition: ssid.cc:92
bool IsEqual(const Ssid &o) const
Check if the two SSIDs are equal.
Definition: ssid.cc:61
uint8_t m_length
Length of the SSID.
Definition: ssid.h:83
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
Definition: ssid.cc:86
char * PeekString() const
Peek the SSID.
Definition: ssid.cc:78
bool IsBroadcast() const
Check if the SSID is broadcast.
Definition: ssid.cc:72
void Print(std::ostream &os) const override
Generate human-readable form of IE.
Definition: ssid.cc:55
uint8_t m_ssid[33]
Raw SSID value.
Definition: ssid.h:82
uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
Definition: ssid.cc:105
Ssid()
Create SSID with broadcast SSID.
Definition: ssid.cc:25
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
Definition: ssid.cc:98
Information element, as defined in 802.11-2007 standard.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ATTRIBUTE_HELPER_HEADER(ValueClassTest)
std::istream & operator>>(std::istream &is, Angles &a)
Definition: angles.cc:183
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
ssid
Definition: third.py:93