address_v6.hpp

//
// ip/address_v6.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_V6_HPP
#define ASIO_IP_ADDRESS_V6_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/socket_types.hpp"
#include "asio/detail/string_view.hpp"
#include "asio/detail/winsock_init.hpp"
#include "asio/error_code.hpp"
#include "asio/ip/address_v4.hpp"

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

#include "asio/detail/push_options.hpp"

namespace asio {
namespace ip {

template <typename> class basic_address_iterator;


class address_v6
{
public:

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

  ASIO_DECL address_v6() ASIO_NOEXCEPT;

  ASIO_DECL explicit address_v6(const bytes_type& bytes,
      unsigned long scope_id = 0);

  ASIO_DECL address_v6(const address_v6& other) ASIO_NOEXCEPT;

#if defined(ASIO_HAS_MOVE)
  ASIO_DECL address_v6(address_v6&& other) ASIO_NOEXCEPT;
#endif // defined(ASIO_HAS_MOVE)

  ASIO_DECL address_v6& operator=(
      const address_v6& other) ASIO_NOEXCEPT;

#if defined(ASIO_HAS_MOVE)
  ASIO_DECL address_v6& operator=(address_v6&& other) ASIO_NOEXCEPT;
#endif // defined(ASIO_HAS_MOVE)


  unsigned long scope_id() const ASIO_NOEXCEPT
  {
    return scope_id_;
  }


  void scope_id(unsigned long id) ASIO_NOEXCEPT
  {
    scope_id_ = id;
  }

  ASIO_DECL bytes_type to_bytes() const ASIO_NOEXCEPT;

  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_v6 from_string(const char* str);

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

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

  static address_v6 from_string(
      const std::string& str, asio::error_code& ec);

  ASIO_DECL address_v4 to_v4() const;
#endif // !defined(ASIO_NO_DEPRECATED)

  ASIO_DECL bool is_loopback() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_unspecified() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_link_local() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_site_local() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_v4_mapped() const ASIO_NOEXCEPT;

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

  ASIO_DECL bool is_multicast() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_multicast_global() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_multicast_link_local() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_multicast_node_local() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_multicast_org_local() const ASIO_NOEXCEPT;

  ASIO_DECL bool is_multicast_site_local() const ASIO_NOEXCEPT;

  ASIO_DECL friend bool operator==(const address_v6& a1,
      const address_v6& a2) ASIO_NOEXCEPT;

  friend bool operator!=(const address_v6& a1,
      const address_v6& a2) ASIO_NOEXCEPT
  {
    return !(a1 == a2);
  }

  ASIO_DECL friend bool operator<(const address_v6& a1,
      const address_v6& a2) ASIO_NOEXCEPT;

  friend bool operator>(const address_v6& a1,
      const address_v6& a2) ASIO_NOEXCEPT
  {
    return a2 < a1;
  }

  friend bool operator<=(const address_v6& a1,
      const address_v6& a2) ASIO_NOEXCEPT
  {
    return !(a2 < a1);
  }

  friend bool operator>=(const address_v6& a1,
      const address_v6& a2) ASIO_NOEXCEPT
  {
    return !(a1 < a2);
  }

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

  ASIO_DECL static address_v6 loopback() ASIO_NOEXCEPT;

#if !defined(ASIO_NO_DEPRECATED)
  ASIO_DECL static address_v6 v4_mapped(const address_v4& addr);

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

private:
  friend class basic_address_iterator<address_v6>;

  // The underlying IPv6 address.
  asio::detail::in6_addr_type addr_;

  // The scope ID associated with the address.
  unsigned long scope_id_;
};


inline address_v6 make_address_v6(const address_v6::bytes_type& bytes,
    unsigned long scope_id = 0)
{
  return address_v6(bytes, scope_id);
}


ASIO_DECL address_v6 make_address_v6(const char* str);


ASIO_DECL address_v6 make_address_v6(const char* str,
    asio::error_code& ec) ASIO_NOEXCEPT;


ASIO_DECL address_v6 make_address_v6(const std::string& str);


ASIO_DECL address_v6 make_address_v6(const std::string& str,
    asio::error_code& ec) ASIO_NOEXCEPT;

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


ASIO_DECL address_v6 make_address_v6(string_view str);


ASIO_DECL address_v6 make_address_v6(string_view str,
    asio::error_code& ec) ASIO_NOEXCEPT;

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

enum v4_mapped_t { v4_mapped };


ASIO_DECL address_v4 make_address_v4(
    v4_mapped_t, const address_v6& v6_addr);


ASIO_DECL address_v6 make_address_v6(
    v4_mapped_t, const address_v4& v4_addr);

#if !defined(ASIO_NO_IOSTREAM)


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

#endif // !defined(ASIO_NO_IOSTREAM)

} // namespace ip
} // namespace asio

#include "asio/detail/pop_options.hpp"

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

#endif // ASIO_IP_ADDRESS_V6_HPP