/usr/include/ns3.27/ns3/wimax-mac-header.h is in libns3-dev 3.27+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 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007,2008, 2009 INRIA, UDcast
*
* 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: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
* Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
*/
#ifndef MAC_HEADER_TYPE_H
#define MAC_HEADER_TYPE_H
#include <stdint.h>
#include "ns3/header.h"
namespace ns3 {
/**
* \ingroup wimax
* This class Represents the HT (Header Type) field of generic MAC and bandwidth request headers
* \see GenericMacHeader
* \see BandwidthRequestHeader
*/
class MacHeaderType : public Header
{
public:
/// Header type enumeration
enum HeaderType
{
HEADER_TYPE_GENERIC,
HEADER_TYPE_BANDWIDTH
};
/**
* Constructor
*/
MacHeaderType (void);
/**
* Constructor
*
* \param type MAC header type
*/
MacHeaderType (uint8_t type);
virtual ~MacHeaderType (void);
/**
* Set type field
* \param type the type
*/
void SetType (uint8_t type);
/**
* Get type field
* \returns the type
*/
uint8_t GetType (void) const;
/**
* Get name field
* \returns the name
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
private:
uint8_t m_type; ///< MAC header type
};
} // namespace ns3
#endif /* MAC_HEADER_TYPE_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef GENERIC_MAC_HEADER_H
#define GENERIC_MAC_HEADER_H
#include <stdint.h>
#include "ns3/header.h"
#include "cid.h"
namespace ns3 {
/**
* \ingroup wimax
* This class implements the Generic mac Header as described by IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems
* 6.3.2.1.1 Generic MAC header, page 36
*/
class GenericMacHeader : public Header
{
public:
GenericMacHeader (void);
~GenericMacHeader (void);
/**
* Set EC field
* \param ec the EC
*/
void SetEc (uint8_t ec);
/**
* Set type field
* \param type the type
*/
void SetType (uint8_t type);
/**
* Set CI field
* \param ci the CI
*/
void SetCi (uint8_t ci);
/**
* Set EKS field
* \param eks the EKS
*/
void SetEks (uint8_t eks);
/**
* Set length field
* \param len the length
*/
void SetLen (uint16_t len);
/**
* Set CID field
* \param cid the CID
*/
void SetCid (Cid cid);
/**
* Set HCS field
* \param hcs the HCS
*/
void SetHcs (uint8_t hcs);
/**
* Set HT field
* \param ht the HT
*/
void SetHt (uint8_t ht);
/**
* Get EC field
* \returns the EC
*/
uint8_t GetEc (void) const;
/**
* Get type field
* \returns the type
*/
uint8_t GetType (void) const;
/**
* Get CI field
* \returns the CI
*/
uint8_t GetCi (void) const;
/**
* Get EKS field
* \returns the EKS
*/
uint8_t GetEks (void) const;
/**
* Get length field
* \returns the length
*/
uint16_t GetLen (void) const;
/**
* Get CID field
* \returns the CID
*/
Cid GetCid (void) const;
/**
* Get HCS field
* \returns the HCS
*/
uint8_t GetHcs (void) const;
/**
* Get HT field
* \returns the HT
*/
uint8_t GetHt (void) const;
/**
* Get name field
* \returns the name
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
/**
* Check HCS
* \returns true if HCS is validated
*/
bool check_hcs (void) const;
private:
uint8_t m_ht; ///< Header type
uint8_t m_ec; ///< Encryption Control
uint8_t m_type; ///< type
uint8_t m_esf; ///< ESF
uint8_t m_ci; ///< CRC Indicator
uint8_t m_eks; ///< Encryption Key Sequence
uint8_t m_rsv1; ///< RSV
uint16_t m_len; ///< length
Cid m_cid; ///< CID
uint8_t m_hcs; ///< Header Check Sequence
uint8_t c_hcs; ///< calculated header check sequence; this is used to check if the received header is correct or not
};
} // namespace ns3
#endif /* GENERIC_MAC_HEADER */
// ----------------------------------------------------------------------------------------------------------
#ifndef BANDWIDTH_REQUEST_HEADER_H
#define BANDWIDTH_REQUEST_HEADER_H
#include <stdint.h>
#include "ns3/header.h"
#include "cid.h"
namespace ns3 {
/**
* \ingroup wimax
* This class implements the bandwidth-request mac Header as described by IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems
* 6.3.2.1.2 Bandwidth request header, page 38
*/
class BandwidthRequestHeader : public Header
{
public:
/// Header type enumeration
enum HeaderType
{
HEADER_TYPE_INCREMENTAL, HEADER_TYPE_AGGREGATE
};
BandwidthRequestHeader (void);
~BandwidthRequestHeader (void);
/**
* Set HT field
* \param ht the HT
*/
void SetHt (uint8_t ht);
/**
* Set EC field
* \param ec the EC
*/
void SetEc (uint8_t ec);
/**
* Set type field
* \param type the type
*/
void SetType (uint8_t type);
/**
* Set BR field
* \param br the BR
*/
void SetBr (uint32_t br);
/**
* Set CID field
* \param cid the CID
*/
void SetCid (Cid cid);
/**
* Set HCS field
* \param hcs the HCS
*/
void SetHcs (uint8_t hcs);
/**
* Get HT field
* \returns the HT
*/
uint8_t GetHt (void) const;
/**
* Get EC field
* \returns the EC
*/
uint8_t GetEc (void) const;
/**
* Get type field
* \returns the type
*/
uint8_t GetType (void) const;
/**
* Get BR field
* \returns the BR
*/
uint32_t GetBr (void) const;
/**
* Get CID field
* \returns the CID
*/
Cid GetCid (void) const;
/**
* Get HCS field
* \returns the HCS
*/
uint8_t GetHcs (void) const;
/**
* Get name field
* \returns the name
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
/**
* Check HCS
* \returns true if HCS is validated
*/
bool check_hcs (void) const;
private:
uint8_t m_ht; ///< Header type
uint8_t m_ec; ///< Encryption Control
uint8_t m_type; ///< type
uint32_t m_br; ///< Bandwidth Request
Cid m_cid; ///< Connection identifier
uint8_t m_hcs; ///< Header Check Sequence
uint8_t c_hcs; ///< calculated header check sequence; this is used to check if the received header is correct or not
};
} // namespace ns3
#endif /* BANDWIDTH_REQUEST_HEADER_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef GRANT_MANAGEMENT_SUBHEADER_H
#define GRANT_MANAGEMENT_SUBHEADER_H
#include <stdint.h>
#include "ns3/header.h"
namespace ns3 {
/**
* \ingroup wimax
* This class implements the grant management sub-header as described by IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems
* 6.3.2.2.2 Grant Management subheader, page 40
*/
class GrantManagementSubheader : public Header
{
public:
GrantManagementSubheader (void);
~GrantManagementSubheader (void);
/**
* Set SI field
* \param si the SI
*/
void SetSi (uint8_t si);
/**
* Set PM field
* \param pm the PM
*/
void SetPm (uint8_t pm);
/**
* Set PRR field
* \param pbr the PBR
*/
void SetPbr (uint16_t pbr);
/**
* Get SI field
* \returns the SI
*/
uint8_t GetSi (void) const;
/**
* Get PM field
* \returns the PM
*/
uint8_t GetPm (void) const;
/**
* Get PBR field
* \returns the PBR
*/
uint16_t GetPbr (void) const;
/**
* Get name field
* \returns the name
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
private:
// size of the Grant Management Subheader shall actually be 2 bytes
uint8_t m_si; ///< Slip Indicator
uint8_t m_pm; ///< Poll-Me bit (byte in this case)
uint16_t m_pbr; ///< PiggyBack Request
};
} // namespace ns3
#endif /* GRANT_MANAGEMENT_SUBHEADER_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef FRAGMENTATION_SUBHEADER_H
#define FRAGMENTATION_SUBHEADER_H
#include <stdint.h>
#include "ns3/header.h"
namespace ns3 {
/**
* \ingroup wimax
* This class implements the fragmentation sub-header as described by IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems
* 6.3.2.2.1 Fragmentation subheader, page 39
*/
class FragmentationSubheader : public Header
{
public:
FragmentationSubheader (void);
~FragmentationSubheader (void);
/**
* Set FC field
* \param fc the FC
*/
void SetFc (uint8_t fc);
/**
* Set FSN field
* \param fsn the FSN
*/
void SetFsn (uint8_t fsn);
/**
* Get FC field
* \returns the FC
*/
uint8_t GetFc (void) const;
/**
* Get FSN field
* \returns the FSN
*/
uint8_t GetFsn (void) const;
/**
* Get name field
* \returns the name
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
private:
uint8_t m_fc; ///< Fragment Control
uint8_t m_fsn; ///< Fragment Sequence Number
};
} // namespace ns3
#endif /* FRAGMENTATION_SUBHEADER_H */
|