mac8-address.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009 University of Washington
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Leonard Tracy <lentracy@gmail.com>
 */
 
#ifndef MAC8_ADDRESS_H
#define MAC8_ADDRESS_H
 
#include "ns3/address.h"
 
#include <compare>
#include <iostream>
 
namespace ns3
{
 
class Address;
 
/**
 * @ingroup network
 *
 * A class used for addressing MAC8 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 Mac8Address
{
  public:
    Mac8Address() = default;
    /**
     * Create Mac8Address object with address addr.
     *
     * @param addr Byte address to assign to this address.
     */
    Mac8Address(uint8_t addr);
    /** Destructor */
    virtual ~Mac8Address();
 
    /**
     * Convert a generic address to a Mac8Address.
     *
     * @param address  Address to convert to Mac8Address address.
     * @return Mac8Address from Address.
     */
    static Mac8Address ConvertFrom(const Address& address);
 
    /**
     * Convert to a generic Address.
     *
     * @return The Address value.
     */
    Address ConvertTo() const;
 
    /**
     * Check that a generic Address is compatible with Mac8Address.
     *
     * @param address  Address to test.
     * @return True if address given is consistent with Mac8Address.
     */
    static bool IsMatchingType(const Address& address);
 
    /**
     * Create a generic Address.
     *
     * @return The Address.
     */
    operator Address() const;
 
    /**
     * Sets address to address stored in parameter.
     *
     * @param pBuffer Buffer to extract address from.
     */
    void CopyFrom(const uint8_t* pBuffer);
 
    /**
     * Writes address to buffer parameter.
     *
     * @param pBuffer
     */
    void CopyTo(uint8_t* pBuffer) const;
 
    /**
     * Get the broadcast address (255).
     *
     * @return Broadcast address.
     */
    static Mac8Address GetBroadcast();
 
    /**
     * Allocates Mac8Address from 0-254
     *
     * Will wrap back to 0 if more than 254 are allocated.
     * Excludes the broadcast address.
     *
     * @return The next sequential Mac8Address.
     */
    static Mac8Address Allocate();
 
    /**
     * Reset the Mac8Address allocation index.
     *
     * This function resets (to zero) the global integer
     * that is used for unique address allocation.
     * It is automatically called whenever
     * @code
     * SimulatorDestroy ();
     * @endcode
     * is called.  It may also be optionally called
     * by user code if there is a need to force a reset
     * of this allocation index.
     */
    static void ResetAllocationIndex();
 
    /**
     * Spaceship comparison operator. All the other comparison operators
     * are automatically generated from this one.
     *
     * @param other address to compare to this one
     * @returns The result of the comparison.
     */
    constexpr std::strong_ordering operator<=>(const Mac8Address& other) const = default;
 
  private:
    static uint8_t m_allocationIndex; //!< Address allocation index
    uint8_t m_address{255};           //!< The address.
 
    /**
     * Get the Mac8Address type.
     *
     * @return The type value.
     */
    static uint8_t GetType();
 
    friend std::ostream& operator<<(std::ostream& os, const Mac8Address& address);
    friend std::istream& operator>>(std::istream& is, Mac8Address& address);
};
 
/**
 * Write \pname{address} to stream \pname{os} as 8 bit integer.
 *
 * @param os The output stream.
 * @param address The address
 * @return The output stream.
 */
std::ostream& operator<<(std::ostream& os, const Mac8Address& address);
 
/**
 * Read \pname{address} from stream \pname{is} as 8 bit integer.
 *
 * @param is The input stream.
 * @param address The address variable to set.
 * @return The input stream.
 */
std::istream& operator>>(std::istream& is, Mac8Address& address);
 
} // namespace ns3
 
#endif /* MAC8_ADDRESS_H */