ipv4-address.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005 INRIA
 *
 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef IPV4_ADDRESS_H
#define IPV4_ADDRESS_H

#include <stdint.h>
#include <ostream>
#include "ns3/address.h"
#include "ns3/attribute-helper.h"

namespace ns3 {

class Ipv4Mask;

class Ipv4Address {
public:
  Ipv4Address ();
  explicit Ipv4Address (uint32_t address);
  Ipv4Address (char const *address);
  uint32_t Get (void) const;
  void Set (uint32_t address);
  void Set (char const *address);
  bool IsEqual (const Ipv4Address &other) const
  {
    return m_address == other.m_address;
  }
  void Serialize (uint8_t buf[4]) const;
  static Ipv4Address Deserialize (const uint8_t buf[4]);
  void Print (std::ostream &os) const;
  bool IsBroadcast (void) const;
  bool IsMulticast (void) const;
  bool IsLocalMulticast (void) const;
  Ipv4Address CombineMask (Ipv4Mask const &mask) const;
  Ipv4Address GetSubnetDirectedBroadcast (Ipv4Mask const &mask) const;
  bool IsSubnetDirectedBroadcast (Ipv4Mask const &mask) const;
  static bool IsMatchingType (const Address &address);
  operator Address () const;
  static Ipv4Address ConvertFrom (const Address &address);
  static Ipv4Address GetZero (void);
  static Ipv4Address GetAny (void);
  static Ipv4Address GetBroadcast (void);
  static Ipv4Address GetLoopback (void);

private:
  Address ConvertTo (void) const;
  static uint8_t GetType (void);
  uint32_t m_address;

  friend bool operator == (Ipv4Address const &a, Ipv4Address const &b);
  friend bool operator != (Ipv4Address const &a, Ipv4Address const &b);
  friend bool operator < (Ipv4Address const &addrA, Ipv4Address const &addrB);
};

class Ipv4Mask {
public:
  Ipv4Mask ();
  Ipv4Mask (uint32_t mask);
  Ipv4Mask (char const *mask);
  bool IsMatch (Ipv4Address a, Ipv4Address b) const;
  bool IsEqual (Ipv4Mask other) const;
  uint32_t Get (void) const;
  void Set (uint32_t mask);
  uint32_t GetInverse (void) const;
  void Print (std::ostream &os) const;
  uint16_t GetPrefixLength (void) const;
  static Ipv4Mask GetLoopback (void);
  static Ipv4Mask GetZero (void);
  static Ipv4Mask GetOnes (void);

private:
  uint32_t m_mask;
};

ATTRIBUTE_HELPER_HEADER (Ipv4Address);  
ATTRIBUTE_HELPER_HEADER (Ipv4Mask);     

std::ostream& operator<< (std::ostream& os, Ipv4Address const& address);
std::ostream& operator<< (std::ostream& os, Ipv4Mask const& mask);
std::istream & operator >> (std::istream &is, Ipv4Address &address);
std::istream & operator >> (std::istream &is, Ipv4Mask &mask);

inline bool operator == (const Ipv4Address &a, const Ipv4Address &b)
{
  return (a.m_address == b.m_address);
}
inline bool operator != (const Ipv4Address &a, const Ipv4Address &b)
{
  return (a.m_address != b.m_address);
}
inline bool operator < (const Ipv4Address &a, const Ipv4Address &b)
{
  return (a.m_address < b.m_address);
}


class Ipv4AddressHash : public std::unary_function<Ipv4Address, size_t> {
public:
  size_t operator() (Ipv4Address const &x) const;
};

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

} // namespace ns3

#endif /* IPV4_ADDRESS_H */