ipv6-address.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007-2008 Louis Pasteur 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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
 */

#ifndef IPV6_ADDRESS_H
#define IPV6_ADDRESS_H

#include <stdint.h>
#include <cstring>

#include <ostream>

#include "ns3/attribute-helper.h"
#include "ns3/address.h"
#include "ns3/ipv4-address.h"
#include "ns3/deprecated.h"
#include "mac8-address.h"

namespace ns3 { 

class Ipv6Prefix;
class Mac16Address;
class Mac48Address;
class Mac64Address;

class Ipv6Address
{
public:
  Ipv6Address ();

  Ipv6Address (char const* address);

  Ipv6Address (uint8_t address[16]);

  Ipv6Address (Ipv6Address const & addr);

  Ipv6Address (Ipv6Address const* addr);

  ~Ipv6Address ();

  void Set (char const* address);

  void Set (uint8_t address[16]);

  NS_DEPRECATED_3_31
  bool IsEqual (const Ipv6Address& other) const;

  void Serialize (uint8_t buf[16]) const;

  static Ipv6Address Deserialize (const uint8_t buf[16]);

  static Ipv6Address MakeSolicitedAddress (Ipv6Address addr);

  static Ipv6Address MakeIpv4MappedAddress (Ipv4Address addr);

  Ipv4Address GetIpv4MappedAddress () const;

  static Ipv6Address MakeAutoconfiguredAddress (Address addr, Ipv6Address prefix);

  static Ipv6Address MakeAutoconfiguredAddress (Address addr, Ipv6Prefix prefix);

  static Ipv6Address MakeAutoconfiguredAddress (Mac16Address addr, Ipv6Address prefix);

  static Ipv6Address MakeAutoconfiguredAddress (Mac48Address addr, Ipv6Address prefix);

  static Ipv6Address MakeAutoconfiguredAddress (Mac64Address addr, Ipv6Address prefix);

  static Ipv6Address MakeAutoconfiguredAddress (Mac8Address addr, Ipv6Address prefix);

  static Ipv6Address MakeAutoconfiguredLinkLocalAddress (Address mac);

  static Ipv6Address MakeAutoconfiguredLinkLocalAddress (Mac16Address mac);

  static Ipv6Address MakeAutoconfiguredLinkLocalAddress (Mac48Address mac);

  static Ipv6Address MakeAutoconfiguredLinkLocalAddress (Mac64Address mac);

  static Ipv6Address MakeAutoconfiguredLinkLocalAddress (Mac8Address mac);

  void Print (std::ostream& os) const;

  bool IsLocalhost () const;

  bool IsMulticast () const;

  bool IsLinkLocalMulticast () const;

  bool IsAllNodesMulticast () const;

  bool IsAllRoutersMulticast () const;

  bool IsLinkLocal () const;

  bool IsSolicitedMulticast () const;

  bool IsAny () const;

  bool IsDocumentation () const;

  bool HasPrefix (Ipv6Prefix const& prefix) const;

  Ipv6Address CombinePrefix (Ipv6Prefix const & prefix) const;

  static bool IsMatchingType (const Address& address);

  bool IsIpv4MappedAddress() const;

  operator Address () const;

  static Ipv6Address ConvertFrom (const Address& address);

  bool IsInitialized (void) const;

  static Ipv6Address GetZero ();

  static Ipv6Address GetAny ();

  static Ipv6Address GetAllNodesMulticast ();

  static Ipv6Address GetAllRoutersMulticast ();

  static Ipv6Address GetAllHostsMulticast ();

  static Ipv6Address GetLoopback ();

  static Ipv6Address GetOnes ();

  void GetBytes (uint8_t buf[16]) const;

private:
  Address ConvertTo (void) const;

  static uint8_t GetType (void);

  uint8_t m_address[16];
  bool m_initialized; 

  friend bool operator == (Ipv6Address const &a, Ipv6Address const &b);

  friend bool operator != (Ipv6Address const &a, Ipv6Address const &b);

  friend bool operator < (Ipv6Address const &a, Ipv6Address const &b);
};

class Ipv6Prefix
{
public:
  Ipv6Prefix ();

  Ipv6Prefix (uint8_t prefix[16]);

  Ipv6Prefix (char const* prefix);

  Ipv6Prefix (uint8_t prefix[16], uint8_t prefixLength);

  Ipv6Prefix (char const* prefix, uint8_t prefixLength);

  Ipv6Prefix (uint8_t prefix);

  Ipv6Prefix (Ipv6Prefix const& prefix);

  Ipv6Prefix (Ipv6Prefix const* prefix);

  ~Ipv6Prefix ();

  bool IsMatch (Ipv6Address a, Ipv6Address b) const;

  void GetBytes (uint8_t buf[16]) const;

  Ipv6Address ConvertToIpv6Address () const;

  uint8_t GetPrefixLength () const;

  void SetPrefixLength (uint8_t prefixLength);

  uint8_t GetMinimumPrefixLength () const;

  NS_DEPRECATED_3_31
  bool IsEqual (const Ipv6Prefix& other) const;

  void Print (std::ostream &os) const;

  static Ipv6Prefix GetLoopback ();

  static Ipv6Prefix GetOnes ();

  static Ipv6Prefix GetZero ();

private:
  uint8_t m_prefix[16];

  uint8_t m_prefixLength;

  friend bool operator == (Ipv6Prefix const &a, Ipv6Prefix const &b);

  friend bool operator != (Ipv6Prefix const &a, Ipv6Prefix const &b);
};

ATTRIBUTE_HELPER_HEADER (Ipv6Address);
ATTRIBUTE_HELPER_HEADER (Ipv6Prefix);

std::ostream & operator << (std::ostream& os, Ipv6Address const& address);

std::ostream & operator << (std::ostream& os, Ipv6Prefix const& prefix);

std::istream & operator >> (std::istream &is, Ipv6Address &address);

std::istream & operator >> (std::istream &is, Ipv6Prefix &prefix);

inline bool operator == (const Ipv6Address& a, const Ipv6Address& b)
{
  return (!std::memcmp (a.m_address, b.m_address, 16));
}

inline bool operator != (const Ipv6Address& a, const Ipv6Address& b)
{
  return std::memcmp (a.m_address, b.m_address, 16);
}

inline bool operator < (const Ipv6Address& a, const Ipv6Address& b)
{
  return (std::memcmp (a.m_address, b.m_address, 16) < 0);
}

inline bool operator == (const Ipv6Prefix& a, const Ipv6Prefix& b)
{
  return (!std::memcmp (a.m_prefix, b.m_prefix, 16));
}

inline bool operator != (const Ipv6Prefix& a, const Ipv6Prefix& b)
{
  return std::memcmp (a.m_prefix, b.m_prefix, 16);
}

class Ipv6AddressHash
{
public:
  size_t operator () (Ipv6Address const &x) const;
};

} /* namespace ns3 */

#endif /* IPV6_ADDRESS_H */