IPV4Address.h

Go to the documentation of this file.

/*
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * IPV4Address.h
 * Represents a IPv4 Address
 * Copyright (C) 2011 Simon Newton
 */

#ifndef INCLUDE_OLA_NETWORK_IPV4ADDRESS_H_
#define INCLUDE_OLA_NETWORK_IPV4ADDRESS_H_

#include <stdint.h>
#include <string.h>
#include <sstream>
#include <string>

namespace ola {
namespace network {

class IPV4Address {
 public:
    enum { LENGTH = 4 };

    IPV4Address() {
      m_address = 0;
    }

    explicit IPV4Address(uint32_t address) {
      m_address = address;
    }

    IPV4Address(const IPV4Address &other)
        : m_address(other.m_address) {
    }

    IPV4Address& operator=(const IPV4Address &other) {
      if (this != &other) {
        m_address = other.m_address;
      }
      return *this;
    }

    bool operator==(const IPV4Address &other) const {
      return m_address == other.m_address;
    }

    bool operator!=(const IPV4Address &other) const {
      return !(*this == other);
    }

    bool operator<(const IPV4Address &other) const;

    bool operator>(const IPV4Address &other) const;

    uint32_t AsInt() const { return m_address; }

    bool IsWildcard() const;

    void Get(uint8_t ptr[LENGTH]) const {
      memcpy(ptr, reinterpret_cast<const uint8_t*>(&m_address), LENGTH);
    }

    std::string ToString() const;

    friend std::ostream& operator<<(std::ostream &out,
                                    const IPV4Address &address) {
      return out << address.ToString();
    }

    static IPV4Address* FromString(const std::string &address);

    static bool FromString(const std::string &address, IPV4Address *target);

    static IPV4Address FromStringOrDie(const std::string &address);

    static bool ToCIDRMask(IPV4Address address, uint8_t *mask);

    static IPV4Address WildCard();

    static IPV4Address Broadcast();

    static IPV4Address Loopback();

 private:
    uint32_t m_address;
};
}  // namespace network
}  // namespace ola
#endif  // INCLUDE_OLA_NETWORK_IPV4ADDRESS_H_