/usr/include/ns3.17/ns3/uan-address.h is in libns3-dev 3.17+dfsg-1build1.
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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 University of Washington
*
* 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: Leonard Tracy <lentracy@gmail.com>
*/
#ifndef UAN_ADDRESS_H
#define UAN_ADDRESS_H
#include "ns3/address.h"
#include <iostream>
namespace ns3 {
/**
* \class UanAddress
*
* A class used for addressing UAN MAC's. This implementation uses a simple 8 bit
* flat addressing scheme. It is unlikely that perceived underwater networks will
* soon exceed 200 nodes (or the overlapping of two underwater networks - the ocean is big),
* so this should provide adequate addressing for most applications.
*/
class UanAddress
{
public:
UanAddress ();
/**
* \param addr byte address to assign to this address
* \brief Create UanAddress object with address addr
*/
UanAddress (uint8_t addr);
virtual ~UanAddress ();
/**
* \param address Address to convert to UAN address
* \returns UanAddress from Address
*/
static UanAddress ConvertFrom (const Address &address);
/**
* \param address Address to test
* \returns True if address given is consistant with UanAddress
*/
static bool IsMatchingType (const Address &address);
/**
* \brief Create UanAddress object with broadcast address
*/
operator Address () const;
/**
* \param pBuffer Buffer to extract address from
* \brief Sets address to address stored in parameter
*/
void CopyFrom (const uint8_t *pBuffer);
/**
* \param pBuffer
* \brief Writes address to buffer parameter
*/
void CopyTo (uint8_t *pBuffer);
/**
* \returns 8 bit integer version of address
*/
uint8_t GetAsInt (void) const;
/**
* \returns Broadcast address: 255
*/
static UanAddress GetBroadcast (void);
/**
* \brief Allocates UanAddress from 0-254 (will wrap back to 0 if more than 255 are allocated)
*/
static UanAddress Allocate ();
private:
uint8_t m_address;
static uint8_t GetType (void);
Address ConvertTo (void) const;
friend bool operator == (const UanAddress &a, const UanAddress &b);
friend bool operator != (const UanAddress &a, const UanAddress &b);
friend std::ostream& operator<< (std::ostream& os, const UanAddress & address);
friend std::istream& operator>> (std::istream& is, UanAddress & address);
};
/**
* \brief Returns true if byte address a is equal to byte address b
*/
bool operator == (const UanAddress &a, const UanAddress &b);
/**
* \brief Returns true if byte address a is unequal to byte address b
*/
bool operator != (const UanAddress &a, const UanAddress &b);
/**
* \brief Writes param address to stream os as 8 bit integer
*/
std::ostream& operator<< (std::ostream& os, const UanAddress & address);
/**
* \brief Inputs param address from stream is as 8 bit integer
*/
std::istream& operator>> (std::istream& is, UanAddress & address);
} // namespace ns3
#endif /* UAN_ADDRESS_H */
|