A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ipv6-option-header.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007-2009 Strasbourg University
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: David Gross <gdavid.devel@gmail.com>
19  */
20 
21 #include "ns3/assert.h"
22 #include "ns3/log.h"
23 #include "ns3/header.h"
24 #include "ipv6-option-header.h"
25 
26 namespace ns3
27 {
28 
29 NS_LOG_COMPONENT_DEFINE ("Ipv6OptionHeader")
30  ;
31 
32 NS_OBJECT_ENSURE_REGISTERED (Ipv6OptionHeader)
33  ;
34 
36 {
37  static TypeId tid = TypeId ("ns3::Ipv6OptionHeader")
39  .SetParent<Header> ()
40  ;
41  return tid;
42 }
43 
45 {
46  return GetTypeId ();
47 }
48 
50  : m_type (0),
51  m_length (0)
52 {
53 }
54 
56 {
57 }
58 
59 void Ipv6OptionHeader::SetType (uint8_t type)
60 {
61  m_type = type;
62 }
63 
64 uint8_t Ipv6OptionHeader::GetType () const
65 {
66  return m_type;
67 }
68 
69 void Ipv6OptionHeader::SetLength (uint8_t length)
70 {
71  m_length = length;
72 }
73 
74 uint8_t Ipv6OptionHeader::GetLength () const
75 {
76  return m_length;
77 }
78 
79 void Ipv6OptionHeader::Print (std::ostream &os) const
80 {
81  os << "( type = " << (uint32_t)m_type << " )";
82 }
83 
85 {
86  return m_length + 2;
87 }
88 
90 {
92 
93  i.WriteU8 (m_type);
94  i.WriteU8 (m_length);
95 
96  i.Write (m_data.Begin (), m_data.End ());
97 }
98 
100 {
102 
103  m_type = i.ReadU8 ();
104  m_length = i.ReadU8 ();
105 
106  m_data = Buffer ();
108  Buffer::Iterator dataStart = i;
109  i.Next (m_length);
110  Buffer::Iterator dataEnd = i;
111  m_data.Begin ().Write (dataStart, dataEnd);
112 
113  return GetSerializedSize ();
114 }
115 
117 {
118  return (Alignment){ 1,0};
119 }
120 
122  ;
123 
125 {
126  static TypeId tid = TypeId ("ns3::Ipv6OptionPad1Header")
128  .SetParent<Ipv6OptionHeader> ()
129  ;
130  return tid;
131 }
132 
134 {
135  return GetTypeId ();
136 }
137 
139 {
140  SetType (0);
141 }
142 
144 {
145 }
146 
147 void Ipv6OptionPad1Header::Print (std::ostream &os) const
148 {
149  os << "( type = " << (uint32_t)GetType () << " )";
150 }
151 
153 {
154  return 1;
155 }
156 
158 {
160 
161  i.WriteU8 (GetType ());
162 }
163 
165 {
167 
168  SetType (i.ReadU8 ());
169 
170  return GetSerializedSize ();
171 }
172 
174  ;
175 
177 {
178  static TypeId tid = TypeId ("ns3::Ipv6OptionPadnHeader")
180  .SetParent<Ipv6OptionHeader> ()
181  ;
182  return tid;
183 }
184 
186 {
187  return GetTypeId ();
188 }
189 
191 {
192  SetType (1);
193  NS_ASSERT_MSG (pad >= 2, "PadN must be at least 2 bytes long");
194  SetLength (pad - 2);
195 }
196 
198 {
199 }
200 
201 void Ipv6OptionPadnHeader::Print (std::ostream &os) const
202 {
203  os << "( type = " << (uint32_t)GetType () << " length = " << (uint32_t)GetLength () << " )";
204 }
205 
207 {
208  return GetLength () + 2;
209 }
210 
212 {
214 
215  i.WriteU8 (GetType ());
216  i.WriteU8 (GetLength ());
217 
218  for (int padding = 0; padding < GetLength (); padding++)
219  {
220  i.WriteU8 (0);
221  }
222 }
223 
225 {
227 
228  SetType (i.ReadU8 ());
229  SetLength (i.ReadU8 ());
230 
231  return GetSerializedSize ();
232 }
233 
235  ;
236 
238 {
239  static TypeId tid = TypeId ("ns3::Ipv6OptionJumbogramHeader")
241  .SetParent<Ipv6OptionHeader> ()
242  ;
243  return tid;
244 }
245 
247 {
248  return GetTypeId ();
249 }
250 
252 {
253  SetType (0xC2);
254  SetLength (4);
255 }
256 
258 {
259 }
260 
262 {
263  m_dataLength = dataLength;
264 }
265 
267 {
268  return m_dataLength;
269 }
270 
271 void Ipv6OptionJumbogramHeader::Print (std::ostream &os) const
272 {
273  os << "( type = " << (uint32_t)GetType () << " length = " << (uint32_t)GetLength () << " data length = " << (uint32_t)m_dataLength << " )";
274 }
275 
277 {
278  return GetLength () + 2;
279 }
280 
282 {
284 
285  i.WriteU8 (GetType ());
286  i.WriteU8 (GetLength ());
288 }
289 
291 {
293 
294  SetType (i.ReadU8 ());
295  SetLength (i.ReadU8 ());
296  m_dataLength = i.ReadNtohU16 ();
297 
298  return GetSerializedSize ();
299 }
300 
302 {
303  return (Alignment){ 4,2}; //4n+2
304 }
305 
307  ;
308 
310 {
311  static TypeId tid = TypeId ("ns3::Ipv6OptionRouterAlertHeader")
313  .SetParent<Ipv6OptionHeader> ()
314  ;
315  return tid;
316 }
317 
319 {
320  return GetTypeId ();
321 }
322 
324  : m_value (0)
325 {
326  SetType (5);
327  SetLength (2);
328 }
329 
331 {
332 }
333 
335 {
336  m_value = value;
337 }
338 
340 {
341  return m_value;
342 }
343 
344 void Ipv6OptionRouterAlertHeader::Print (std::ostream &os) const
345 {
346  os << "( type = " << (uint32_t)GetType () << " length = " << (uint32_t)GetLength () << " value = " << (uint32_t)m_value << " )";
347 }
348 
350 {
351  return GetLength () + 2;
352 }
353 
355 {
357 
358  i.WriteU8 (GetType ());
359  i.WriteU8 (GetLength ());
360  i.WriteHtonU16 (m_value);
361 }
362 
364 {
366 
367  SetType (i.ReadU8 ());
368  SetLength (i.ReadU8 ());
369  m_value = i.ReadNtohU16 ();
370 
371  return GetSerializedSize ();
372 }
373 
375 {
376  return (Alignment){ 2,0}; //2n+0
377 }
378 
379 } /* namespace ns3 */
380 
virtual TypeId GetInstanceTypeId() const
Get the instance type ID.
TypeId AddConstructor(void)
Definition: type-id.h:418
NS_LOG_COMPONENT_DEFINE("GrantedTimeWindowMpiInterface")
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
void SetType(uint8_t type)
Set the type of the option.
Doxygen introspection did not find any typical Config paths.
virtual Alignment GetAlignment() const
Get the Alignment requirement of this option header.
virtual ~Ipv6OptionPad1Header()
Destructor.
Ipv6OptionPadnHeader(uint32_t pad=2)
Constructor.
automatically resized byte buffer
Definition: buffer.h:92
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
virtual TypeId GetInstanceTypeId() const
Get the instance type ID.
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
static TypeId GetTypeId()
Get the type identificator.
virtual void Print(std::ostream &os) const
Print some informations about the packet.
uint8_t m_type
The type of the option.
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
virtual TypeId GetInstanceTypeId() const
Get the instance type ID.
Doxygen introspection did not find any typical Config paths.
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
uint8_t GetType() const
Get the type of the option.
static TypeId GetTypeId()
Get the type identificator.
virtual TypeId GetInstanceTypeId() const
Get the instance type ID.
represents the alignment requirements of an option header
virtual uint32_t GetSerializedSize() const
Get the serialized size of the packet.
iterator in a Buffer instance
Definition: buffer.h:98
virtual uint32_t GetSerializedSize() const
Get the serialized size of the packet.
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
virtual void Print(std::ostream &os) const
Print some informations about the packet.
virtual TypeId GetInstanceTypeId() const
Get the instance type ID.
virtual ~Ipv6OptionHeader()
Destructor.
virtual uint32_t GetSerializedSize() const
Get the serialized size of the packet.
static TypeId GetTypeId()
Get the type identificator.
virtual void Print(std::ostream &os) const
Print some informations about the packet.
void WriteHtonU16(uint16_t data)
Definition: buffer.h:726
Buffer::Iterator End(void) const
Definition: buffer.h:881
void Next(void)
go forward by one byte
Definition: buffer.h:666
virtual ~Ipv6OptionJumbogramHeader()
Destructor.
Buffer m_data
The anonymous data of this option.
Doxygen introspection did not find any typical Config paths.
virtual ~Ipv6OptionRouterAlertHeader()
Destructor.
Buffer::Iterator Begin(void) const
Definition: buffer.h:875
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
void SetDataLength(uint32_t dataLength)
Set the data length.
virtual Alignment GetAlignment() const
Get the Alignment requirement of this option header.
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
virtual ~Ipv6OptionPadnHeader()
Destructor.
virtual Alignment GetAlignment() const
Get the Alignment requirement of this option header.
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
virtual uint32_t GetSerializedSize() const
Get the serialized size of the packet.
void WriteHtonU32(uint32_t data)
Definition: buffer.h:745
void SetValue(uint16_t value)
Set the field "value".
uint32_t GetDataLength() const
Get the data length.
bool AddAtEnd(uint32_t end)
Definition: buffer.cc:356
#define NS_ASSERT_MSG(condition, message)
Definition: assert.h:86
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
static TypeId GetTypeId()
Get the type identificator.
void WriteU8(uint8_t data)
Definition: buffer.h:690
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
uint8_t GetLength() const
Get the option length.
uint8_t ReadU8(void)
Definition: buffer.h:819
void Write(uint8_t const *buffer, uint32_t size)
Definition: buffer.cc:978
Doxygen introspection did not find any typical Config paths.
uint16_t ReadNtohU16(void)
Definition: buffer.h:767
uint16_t GetValue() const
Get the field "value".
virtual uint32_t GetSerializedSize() const
Get the serialized size of the packet.
uint8_t m_length
The option length.
static TypeId GetTypeId()
Get the type identificator.
a unique identifier for an interface.
Definition: type-id.h:49
void SetLength(uint8_t length)
Set the option length.
Doxygen introspection did not find any typical Config paths.
virtual void Print(std::ostream &os) const
Print some informations about the packet.
virtual void Print(std::ostream &os) const
Print some informations about the packet.
uint32_t m_dataLength
The data length.
Ipv6OptionHeader()
Constructor.