address_v4.hpp

//
// ip/address_v4.hpp
// ~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2020 Christopher M. Kohlhoff (chris at kohlhoff dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//

#ifndef ASIO_IP_ADDRESS_V4_HPP
#define ASIO_IP_ADDRESS_V4_HPP

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include "asio/detail/config.hpp"
#include <string>
#include "asio/detail/array.hpp"
#include "asio/detail/cstdint.hpp"
#include "asio/detail/socket_types.hpp"
#include "asio/detail/string_view.hpp"
#include "asio/detail/winsock_init.hpp"
#include "asio/error_code.hpp"

#if !defined(ASIO_NO_IOSTREAM)
# include <iosfwd>
#endif // !defined(ASIO_NO_IOSTREAM)

#include "asio/detail/push_options.hpp"

namespace asio {
namespace ip {


class address_v4
{
public:
  typedef uint_least32_t uint_type;


#if defined(GENERATING_DOCUMENTATION)
  typedef array<unsigned char, 4> bytes_type;
#else
  typedef asio::detail::array<unsigned char, 4> bytes_type;
#endif

  address_v4() ASIO_NOEXCEPT
  {
    addr_.s_addr = 0;
  }

  ASIO_DECL explicit address_v4(const bytes_type& bytes);

  ASIO_DECL explicit address_v4(uint_type addr);

  address_v4(const address_v4& other) ASIO_NOEXCEPT
    : addr_(other.addr_)
  {
  }

#if defined(ASIO_HAS_MOVE)
  address_v4(address_v4&& other) ASIO_NOEXCEPT
    : addr_(other.addr_)
  {
  }
#endif // defined(ASIO_HAS_MOVE)

  address_v4& operator=(const address_v4& other) ASIO_NOEXCEPT
  {
    addr_ = other.addr_;
    return *this;
  }

#if defined(ASIO_HAS_MOVE)
  address_v4& operator=(address_v4&& other) ASIO_NOEXCEPT
  {
    addr_ = other.addr_;
    return *this;
  }
#endif // defined(ASIO_HAS_MOVE)

  ASIO_DECL bytes_type to_bytes() const ASIO_NOEXCEPT;

  ASIO_DECL uint_type to_uint() const ASIO_NOEXCEPT;

#if !defined(ASIO_NO_DEPRECATED)
  ASIO_DECL unsigned long to_ulong() const;
#endif // !defined(ASIO_NO_DEPRECATED)

  ASIO_DECL std::string to_string() const;

#if !defined(ASIO_NO_DEPRECATED)
  ASIO_DECL std::string to_string(asio::error_code& ec) const;

  static address_v4 from_string(const char* str);

  static address_v4 from_string(
      const char* str, asio::error_code& ec);

  static address_v4 from_string(const std::string& str);

  static address_v4 from_string(
      const std::string& str, asio::error_code& ec);
#endif // !defined(ASIO_NO_DEPRECATED)

  ASIO_DECL bool is_loopback() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_unspecified() const ASIO_NOEXCEPT;

#if !defined(ASIO_NO_DEPRECATED)
  ASIO_DECL bool is_class_a() const;

  ASIO_DECL bool is_class_b() const;

  ASIO_DECL bool is_class_c() const;
#endif // !defined(ASIO_NO_DEPRECATED)

  ASIO_DECL bool is_multicast() const ASIO_NOEXCEPT;

  friend bool operator==(const address_v4& a1,
      const address_v4& a2) ASIO_NOEXCEPT
  {
    return a1.addr_.s_addr == a2.addr_.s_addr;
  }

  friend bool operator!=(const address_v4& a1,
      const address_v4& a2) ASIO_NOEXCEPT
  {
    return a1.addr_.s_addr != a2.addr_.s_addr;
  }

  friend bool operator<(const address_v4& a1,
      const address_v4& a2) ASIO_NOEXCEPT
  {
    return a1.to_uint() < a2.to_uint();
  }

  friend bool operator>(const address_v4& a1,
      const address_v4& a2) ASIO_NOEXCEPT
  {
    return a1.to_uint() > a2.to_uint();
  }

  friend bool operator<=(const address_v4& a1,
      const address_v4& a2) ASIO_NOEXCEPT
  {
    return a1.to_uint() <= a2.to_uint();
  }

  friend bool operator>=(const address_v4& a1,
      const address_v4& a2) ASIO_NOEXCEPT
  {
    return a1.to_uint() >= a2.to_uint();
  }

  static address_v4 any() ASIO_NOEXCEPT
  {
    return address_v4();
  }

  static address_v4 loopback() ASIO_NOEXCEPT
  {
    return address_v4(0x7F000001);
  }

  static address_v4 broadcast() ASIO_NOEXCEPT
  {
    return address_v4(0xFFFFFFFF);
  }

#if !defined(ASIO_NO_DEPRECATED)
  ASIO_DECL static address_v4 broadcast(
      const address_v4& addr, const address_v4& mask);

  ASIO_DECL static address_v4 netmask(const address_v4& addr);
#endif // !defined(ASIO_NO_DEPRECATED)

private:
  // The underlying IPv4 address.
  asio::detail::in4_addr_type addr_;
};


inline address_v4 make_address_v4(const address_v4::bytes_type& bytes)
{
  return address_v4(bytes);
}


inline address_v4 make_address_v4(address_v4::uint_type addr)
{
  return address_v4(addr);
}


ASIO_DECL address_v4 make_address_v4(const char* str);


ASIO_DECL address_v4 make_address_v4(const char* str,
    asio::error_code& ec) ASIO_NOEXCEPT;


ASIO_DECL address_v4 make_address_v4(const std::string& str);


ASIO_DECL address_v4 make_address_v4(const std::string& str,
    asio::error_code& ec) ASIO_NOEXCEPT;

#if defined(ASIO_HAS_STRING_VIEW) \
  || defined(GENERATING_DOCUMENTATION)


ASIO_DECL address_v4 make_address_v4(string_view str);


ASIO_DECL address_v4 make_address_v4(string_view str,
    asio::error_code& ec) ASIO_NOEXCEPT;

#endif // defined(ASIO_HAS_STRING_VIEW)
       //  || defined(GENERATING_DOCUMENTATION)

#if !defined(ASIO_NO_IOSTREAM)


template <typename Elem, typename Traits>
std::basic_ostream<Elem, Traits>& operator<<(
    std::basic_ostream<Elem, Traits>& os, const address_v4& addr);

#endif // !defined(ASIO_NO_IOSTREAM)

} // namespace ip
} // namespace asio

#include "asio/detail/pop_options.hpp"

#include "asio/ip/impl/address_v4.hpp"
#if defined(ASIO_HEADER_ONLY)
# include "asio/ip/impl/address_v4.ipp"
#endif // defined(ASIO_HEADER_ONLY)

#endif // ASIO_IP_ADDRESS_V4_HPP