IPAddress.h

Go to the documentation of this file.

//
// Copyright (C) 2001  Vincent Oberle (vincent@oberle.com)
// Institute of Telematics, University of Karlsruhe, Germany.
// University Comillas, Madrid, Spain.
// Copyright (C) 2004 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program; if not, see <http://www.gnu.org/licenses/>.
//

//
// Author: Vincent Oberle, Jan-March 2001
// Cleanup and rewrite: Andras Varga, 2004
//

#ifndef __INET_IPADDRESS_H
#define __INET_IPADDRESS_H

#include <omnetpp.h>
#include <iostream>
#include <string>
#include "INETDefs.h"


const short PORT_UNDEF = 0;
const short PORT_MAX = 0x7fff;

class INET_API IPAddress
{
  protected:
    // Address is encoded in a single uint32
    uint32 addr;

  protected:
    // Only keeps the n first bits of the address, completing it with zeros.
    // Typical usage is when the length of an IP prefix is done and to check
    // the address ends with the right number of 0.
    void keepFirstBits (unsigned int n);

    // Parses IP address into the given bytes, and returns true if syntax was OK.
    static bool parseIPAddress(const char *text, unsigned char tobytes[]);

  public:
    static const IPAddress UNSPECIFIED_ADDRESS; 
    static const IPAddress LOOPBACK_ADDRESS;    
    static const IPAddress LOOPBACK_NETMASK;    
    static const IPAddress ALLONES_ADDRESS;     

    static const IPAddress ALL_HOSTS_MCAST;          
    static const IPAddress ALL_ROUTERS_MCAST;        
    static const IPAddress ALL_DVMRP_ROUTERS_MCAST;  
    static const IPAddress ALL_OSPF_ROUTERS_MCAST;   
    static const IPAddress ALL_OSPF_DESIGNATED_ROUTERS_MCAST;  



    IPAddress() {addr = 0;}

    IPAddress(uint32 ip) {addr = ip;}

    IPAddress(int i0, int i1, int i2, int i3) {set(i0, i1, i2, i3);}

    IPAddress(const char *text) {set(text);}

    IPAddress(const IPAddress& obj) {operator=(obj);}

    ~IPAddress() {}

    void set(uint32 ip) {addr = ip;}

    void set(int i0, int i1, int i2, int i3);

    void set(const char *t);

    IPAddress& operator=(const IPAddress& obj) {addr = obj.addr; return *this;}

    bool isUnspecified() const {return addr==0;}

    bool equals(const IPAddress& toCmp) const {return addr == toCmp.addr;}

    IPAddress doAnd(const IPAddress& ip) const {return addr & ip.addr;}

    std::string str() const;

    uint32 getInt() const {return addr;}

    int getDByte(int i) const {return (addr >> (3-i)*8) & 0xFF;}

    char getIPClass() const;

    bool isMulticast() const {return (addr & 0xF0000000)==0xE0000000;}

     bool isLinkLocalMulticast() const {return (addr & 0xFFFFFF00) == 0xE0000000;}

    IPAddress getNetwork() const;

    IPAddress getNetworkMask() const;

    bool isNetwork(const IPAddress& toCmp) const;

    bool prefixMatches(const IPAddress& to_cmp, int numbits) const;

    int getNumMatchingPrefixBits(const IPAddress& to_cmp) const;

    int getNetmaskLength() const;

    static bool maskedAddrAreEqual(const IPAddress& addr1,
                                   const IPAddress& addr2,
                                   const IPAddress& netmask);

    bool operator==(const IPAddress& addr1) const {return equals(addr1);}

    bool operator!=(const IPAddress& addr1) const {return !equals(addr1);}

    bool operator<(const IPAddress& addr1) const {return getInt()<addr1.getInt();}

    static bool isWellFormed(const char *text);
};

inline std::ostream& operator<<(std::ostream& os, const IPAddress& ip)
{
    return os << ip.str();
}

inline void doPacking(cCommBuffer *buf, const IPAddress& addr)
{
    buf->pack(addr.getInt());
}

inline void doUnpacking(cCommBuffer *buf, IPAddress& addr)
{
    int32 d; buf->unpack(d); addr.set(d);
}

#endif