/usr/include/ns3/ipv6-option-header.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008-2009 Strasbourg University
*
* 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: David Gross <gdavid.devel@gmail.com>
*/
#ifndef IPV6_OPTION_HEADER_H
#define IPV6_OPTION_HEADER_H
#include <ostream>
#include "ns3/header.h"
namespace ns3
{
/**
* \class Ipv6OptionHeader
* \brief Header for IPv6 Option.
*/
class Ipv6OptionHeader : public Header
{
public:
/**
* \struct Alignment
* \brief represents the alignment requirements of an option header
*
* Represented as factor*n+offset (eg. 8n+2) See RFC 2460.
* No alignment is represented as 1n+0.
*/
struct Alignment
{
uint8_t factor; /**< Factor */
uint8_t offset; /**< Offset */
};
/**
* \brief Get the type identificator.
* \return type identificator
*/
static TypeId GetTypeId ();
/**
* \brief Get the instance type ID.
* \return instance type ID
*/
virtual TypeId GetInstanceTypeId () const;
/**
* \brief Constructor.
*/
Ipv6OptionHeader ();
/**
* \brief Destructor.
*/
virtual ~Ipv6OptionHeader ();
/**
* \brief Set the type of the option.
* \param type the type of the option
*/
void SetType (uint8_t type);
/**
* \brief Get the type of the option.
* \return the type of the option
*/
uint8_t GetType () const;
/**
* \brief Set the option length.
* \param length the option length
*/
void SetLength (uint8_t length);
/**
* \brief Get the option length.
* \return the option length
*/
uint8_t GetLength () const;
/**
* \brief Print some informations about the packet.
* \param os output stream
* \return info about this packet
*/
virtual void Print (std::ostream &os) const;
/**
* \brief Get the serialized size of the packet.
* \return size
*/
virtual uint32_t GetSerializedSize () const;
/**
* \brief Serialize the packet.
* \param start Buffer iterator
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
* \param start Buffer iterator
* \return size of the packet
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Get the Alignment requirement of this option header
* \return The required alignment
*
* Subclasses should only implement this method, if special alignment is
* required. Default is no alignment (1n+0).
*/
virtual Alignment GetAlignment () const;
private:
/**
* \brief The type of the option.
*/
uint8_t m_type;
/**
* \brief The option length.
*/
uint8_t m_length;
/**
* \brief The anonymous data of this option
*/
Buffer m_data;
};
/**
* \class Ipv6OptionPad1Header
* \brief Header of IPv6 Option Pad1
*/
class Ipv6OptionPad1Header : public Ipv6OptionHeader
{
public:
/**
* \brief Get the type identificator.
* \return type identificator
*/
static TypeId GetTypeId ();
/**
* \brief Get the instance type ID.
* \return instance type ID
*/
virtual TypeId GetInstanceTypeId () const;
/**
* \brief Constructor.
*/
Ipv6OptionPad1Header ();
/**
* \brief Destructor.
*/
virtual ~Ipv6OptionPad1Header ();
/**
* \brief Print some informations about the packet.
* \param os output stream
* \return info about this packet
*/
virtual void Print (std::ostream &os) const;
/**
* \brief Get the serialized size of the packet.
* \return size
*/
virtual uint32_t GetSerializedSize () const;
/**
* \brief Serialize the packet.
* \param start Buffer iterator
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
* \param start Buffer iterator
* \return size of the packet
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
};
/**
* \class Ipv6OptionPadnHeader
* \brief Header of IPv6 Option Padn
*/
class Ipv6OptionPadnHeader : public Ipv6OptionHeader
{
public:
/**
* \brief Get the type identificator.
* \return type identificator
*/
static TypeId GetTypeId ();
/**
* \brief Get the instance type ID.
* \return instance type ID
*/
virtual TypeId GetInstanceTypeId () const;
/**
* \brief Constructor.
* \param pad Number of bytes to pad (>=2)
*/
Ipv6OptionPadnHeader (uint32_t pad = 2);
/**
* \brief Destructor.
*/
virtual ~Ipv6OptionPadnHeader ();
/**
* \brief Print some informations about the packet.
* \param os output stream
* \return info about this packet
*/
virtual void Print (std::ostream &os) const;
/**
* \brief Get the serialized size of the packet.
* \return size
*/
virtual uint32_t GetSerializedSize () const;
/**
* \brief Serialize the packet.
* \param start Buffer iterator
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
* \param start Buffer iterator
* \return size of the packet
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
};
/**
* \class Ipv6OptionJumbogramHeader
* \brief Header of IPv6 Option Jumbogram
*/
class Ipv6OptionJumbogramHeader : public Ipv6OptionHeader
{
public:
/**
* \brief Get the type identificator.
* \return type identificator
*/
static TypeId GetTypeId ();
/**
* \brief Get the instance type ID.
* \return instance type ID
*/
virtual TypeId GetInstanceTypeId () const;
/**
* \brief Constructor.
*/
Ipv6OptionJumbogramHeader ();
/**
* \brief Destructor.
*/
virtual ~Ipv6OptionJumbogramHeader ();
/**
* \brief Set the data length.
* \param dataLength the data length
*/
void SetDataLength (uint32_t dataLength);
/**
* \brief Get the data length.
* \return the data length
*/
uint32_t GetDataLength () const;
/**
* \brief Print some informations about the packet.
* \param os output stream
* \return info about this packet
*/
virtual void Print (std::ostream &os) const;
/**
* \brief Get the serialized size of the packet.
* \return size
*/
virtual uint32_t GetSerializedSize () const;
/**
* \brief Serialize the packet.
* \param start Buffer iterator
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
* \param start Buffer iterator
* \return size of the packet
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Get the Alignment requirement of this option header
* \return The required alignment
*/
virtual Alignment GetAlignment () const;
private:
/**
* \brief The data length.
*/
uint32_t m_dataLength;
};
/**
* \class Ipv6OptionRouterAlertHeader
* \brief Header of IPv6 Option Router Alert
*/
class Ipv6OptionRouterAlertHeader : public Ipv6OptionHeader
{
public:
/**
* \brief Get the type identificator.
* \return type identificator
*/
static TypeId GetTypeId ();
/**
* \brief Get the instance type ID.
* \return instance type ID
*/
virtual TypeId GetInstanceTypeId () const;
/**
* \brief Constructor.
*/
Ipv6OptionRouterAlertHeader ();
/**
* \brief Destructor.
*/
virtual ~Ipv6OptionRouterAlertHeader ();
/**
* \brief Set the field "value".
*/
void SetValue (uint16_t value);
/**
* \brief Get the field "value".
* \return the field "value"
*/
uint16_t GetValue () const;
/**
* \brief Print some informations about the packet.
* \param os output stream
* \return info about this packet
*/
virtual void Print (std::ostream &os) const;
/**
* \brief Get the serialized size of the packet.
* \return size
*/
virtual uint32_t GetSerializedSize () const;
/**
* \brief Serialize the packet.
* \param start Buffer iterator
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
* \param start Buffer iterator
* \return size of the packet
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Get the Alignment requirement of this option header
* \return The required alignment
*/
virtual Alignment GetAlignment () const;
private:
/**
* \brief The value.
*/
uint16_t m_value;
};
} // namespace ns3
#endif /* IPV6_OPTION_HEADER_H */
|