ipv6-interface-address.h

Go to the documentation of this file.

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

#ifndef IPV6_INTERFACE_ADDRESS_H
#define IPV6_INTERFACE_ADDRESS_H 

#include <stdint.h>

#include "ns3/ipv6-address.h"

namespace ns3
{

class Ipv6InterfaceAddress
{
public:
  enum State_e
  {
    TENTATIVE, 
    DEPRECATED, 
    PREFERRED, 
    PERMANENT, 
    HOMEADDRESS, 
    TENTATIVE_OPTIMISTIC, 
    INVALID, 
  };

  enum Scope_e
  {
    HOST, 
    LINKLOCAL, 
    GLOBAL, 
  };

  Ipv6InterfaceAddress ();

  Ipv6InterfaceAddress (Ipv6Address address);

  Ipv6InterfaceAddress (Ipv6Address address, Ipv6Prefix prefix);

  Ipv6InterfaceAddress (Ipv6Address address, Ipv6Prefix prefix, bool onLink);

  Ipv6InterfaceAddress (const Ipv6InterfaceAddress& o);

  ~Ipv6InterfaceAddress ();

  void SetAddress (Ipv6Address address);

  Ipv6Address GetAddress () const;

  Ipv6Prefix GetPrefix () const;

  void SetState (Ipv6InterfaceAddress::State_e state);

  Ipv6InterfaceAddress::State_e GetState () const;

  void SetScope (Ipv6InterfaceAddress::Scope_e scope);

  Ipv6InterfaceAddress::Scope_e GetScope () const;

  bool IsInSameSubnet (Ipv6Address b) const;

  void SetNsDadUid (uint32_t uid);

  uint32_t GetNsDadUid () const;

  void SetOnLink (bool onLink);

  bool GetOnLink () const;

#if 0

  void StartDadTimer (Ptr<Ipv6Interface> interface);

  void StopDadTimer ();
#endif

private:
  Ipv6Address m_address;

  Ipv6Prefix m_prefix;

  State_e m_state;

  Scope_e m_scope;

  bool m_onLink;

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

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

  uint32_t m_nsDadUid;
};

std::ostream& operator<< (std::ostream& os, const Ipv6InterfaceAddress &addr);

/* follow Ipv4InterfaceAddress way, maybe not inline them */
inline bool operator == (const Ipv6InterfaceAddress& a, const Ipv6InterfaceAddress& b)
{
  return (a.m_address == b.m_address && a.m_prefix == b.m_prefix &&
          a.m_state == b.m_state && a.m_scope == b.m_scope);
}

inline bool operator != (const Ipv6InterfaceAddress& a, const Ipv6InterfaceAddress& b)
{
  return (a.m_address != b.m_address || a.m_prefix != b.m_prefix ||
          a.m_state != b.m_state || a.m_scope != b.m_scope);
}

} /* namespace ns3 */

#endif /* IPV6_INTERFACE_ADDRESS_H */