A Discrete-Event Network Simulator
API
ie-dot11s-rann.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008,2009 IITP RAS
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Kirill Andreev <andreev@iitp.ru>
19  */
20 
21 #ifndef RANN_INFORMATION_ELEMENT_H
22 #define RANN_INFORMATION_ELEMENT_H
23 
24 #include "ns3/mac48-address.h"
25 #include "ns3/mesh-information-element-vector.h"
26 
27 namespace ns3 {
28 namespace dot11s {
34 {
35 public:
36  IeRann ();
37  virtual ~IeRann ();
42  void SetFlags (uint8_t flags);
48  void SetHopcount (uint8_t hopcount);
53  void SetTTL (uint8_t ttl);
58  void SetOriginatorAddress (Mac48Address originator_address);
63  void SetDestSeqNumber (uint32_t dest_seq_number);
69  void SetMetric (uint32_t metric);
74  uint8_t GetFlags ();
79  uint8_t GetHopcount ();
84  uint8_t GetTtl ();
94  uint32_t GetDestSeqNumber ();
99  uint32_t GetMetric ();
101  void DecrementTtl ();
106  void IncrementMetric (uint32_t metric);
107 
108  // Inherited from WifiInformationElement
109  virtual WifiInformationElementId ElementId () const;
110  virtual void SerializeInformationField (Buffer::Iterator i) const;
111  virtual uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
112  virtual uint8_t GetInformationFieldSize () const;
113  virtual void Print (std::ostream &os) const;
114 
115 private:
116  uint8_t m_flags;
117  uint8_t m_hopcount;
118  uint8_t m_ttl;
120  uint32_t m_destSeqNumber;
121  uint32_t m_metric;
122 
130  friend bool operator== (const IeRann & a, const IeRann & b);
131 };
132 
133 bool operator== (const IeRann & a, const IeRann & b);
134 std::ostream &operator << (std::ostream &os, const IeRann &rann);
135 } // namespace dot11s
136 } // namespace ns3
137 
138 #endif
iterator in a Buffer instance
Definition: buffer.h:99
an EUI-48 address
Definition: mac48-address.h:44
Information element, as defined in 802.11-2007 standard.
Root announcement (RANN) element.
uint8_t GetTtl()
Get TTL value.
void SetMetric(uint32_t metric)
Set metric value to cumulative metric from originating root mesh STA to the mesh STA transmitting the...
uint8_t m_flags
flags
uint8_t GetFlags()
Get flags value.
Mac48Address m_originatorAddress
originator address
virtual uint8_t GetInformationFieldSize() const
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
friend bool operator==(const IeRann &a, const IeRann &b)
equality operator
virtual uint8_t DeserializeInformationField(Buffer::Iterator start, uint8_t length)
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
virtual void Print(std::ostream &os) const
Generate human-readable form of IE.
void SetTTL(uint8_t ttl)
Set TTL value to the remaining number of hops allowed.
void IncrementMetric(uint32_t metric)
Increment metric.
uint8_t m_hopcount
hop count
uint32_t m_destSeqNumber
destination sequence number
virtual void SerializeInformationField(Buffer::Iterator i) const
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint32_t GetMetric()
Get metric value.
uint32_t GetDestSeqNumber()
Get destination sequence number value.
void DecrementTtl()
Decrement TTL function.
uint8_t GetHopcount()
Get hop count value.
void SetHopcount(uint8_t hopcount)
Set hop count value to number of hops from the originating root mesh STA to the mesh STA transmitting...
void SetOriginatorAddress(Mac48Address originator_address)
Set originator address value.
virtual WifiInformationElementId ElementId() const
void SetDestSeqNumber(uint32_t dest_seq_number)
Set destination sequence number value.
uint32_t m_metric
metric
void SetFlags(uint8_t flags)
Set flags field.
Mac48Address GetOriginatorAddress()
Get originator address value.
bool operator==(const MeshHeader &a, const MeshHeader &b)
std::ostream & operator<<(std::ostream &os, const IeBeaconTiming &a)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
def start()
Definition: core.py:1853