summaryrefslogtreecommitdiffstats
path: root/lib/asio/ip/address_v6.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'lib/asio/ip/address_v6.hpp')
-rw-r--r--lib/asio/ip/address_v6.hpp336
1 files changed, 336 insertions, 0 deletions
diff --git a/lib/asio/ip/address_v6.hpp b/lib/asio/ip/address_v6.hpp
new file mode 100644
index 0000000..fece332
--- /dev/null
+++ b/lib/asio/ip/address_v6.hpp
@@ -0,0 +1,336 @@
+//
+// ip/address_v6.hpp
+// ~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2018 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;
+
+/// Implements IP version 6 style addresses.
+/**
+ * The asio::ip::address_v6 class provides the ability to use and
+ * manipulate IP version 6 addresses.
+ *
+ * @par Thread Safety
+ * @e Distinct @e objects: Safe.@n
+ * @e Shared @e objects: Unsafe.
+ */
+class address_v6
+{
+public:
+ /// The type used to represent an address as an array of bytes.
+ /**
+ * @note This type is defined in terms of the C++0x template @c std::array
+ * when it is available. Otherwise, it uses @c boost:array.
+ */
+#if defined(GENERATING_DOCUMENTATION)
+ typedef array<unsigned char, 16> bytes_type;
+#else
+ typedef asio::detail::array<unsigned char, 16> bytes_type;
+#endif
+
+ /// Default constructor.
+ ASIO_DECL address_v6();
+
+ /// Construct an address from raw bytes and scope ID.
+ ASIO_DECL explicit address_v6(const bytes_type& bytes,
+ unsigned long scope_id = 0);
+
+ /// Copy constructor.
+ ASIO_DECL address_v6(const address_v6& other);
+
+#if defined(ASIO_HAS_MOVE)
+ /// Move constructor.
+ ASIO_DECL address_v6(address_v6&& other);
+#endif // defined(ASIO_HAS_MOVE)
+
+ /// Assign from another address.
+ ASIO_DECL address_v6& operator=(const address_v6& other);
+
+#if defined(ASIO_HAS_MOVE)
+ /// Move-assign from another address.
+ ASIO_DECL address_v6& operator=(address_v6&& other);
+#endif // defined(ASIO_HAS_MOVE)
+
+ /// The scope ID of the address.
+ /**
+ * Returns the scope ID associated with the IPv6 address.
+ */
+ unsigned long scope_id() const
+ {
+ return scope_id_;
+ }
+
+ /// The scope ID of the address.
+ /**
+ * Modifies the scope ID associated with the IPv6 address.
+ */
+ void scope_id(unsigned long id)
+ {
+ scope_id_ = id;
+ }
+
+ /// Get the address in bytes, in network byte order.
+ ASIO_DECL bytes_type to_bytes() const;
+
+ /// Get the address as a string.
+ ASIO_DECL std::string to_string() const;
+
+#if !defined(ASIO_NO_DEPRECATED)
+ /// (Deprecated: Use other overload.) Get the address as a string.
+ ASIO_DECL std::string to_string(asio::error_code& ec) const;
+
+ /// (Deprecated: Use make_address_v6().) Create an IPv6 address from an IP
+ /// address string.
+ static address_v6 from_string(const char* str);
+
+ /// (Deprecated: Use make_address_v6().) Create an IPv6 address from an IP
+ /// address string.
+ static address_v6 from_string(
+ const char* str, asio::error_code& ec);
+
+ /// (Deprecated: Use make_address_v6().) Create an IPv6 address from an IP
+ /// address string.
+ static address_v6 from_string(const std::string& str);
+
+ /// (Deprecated: Use make_address_v6().) Create an IPv6 address from an IP
+ /// address string.
+ static address_v6 from_string(
+ const std::string& str, asio::error_code& ec);
+
+ /// (Deprecated: Use make_address_v4().) Converts an IPv4-mapped or
+ /// IPv4-compatible address to an IPv4 address.
+ ASIO_DECL address_v4 to_v4() const;
+#endif // !defined(ASIO_NO_DEPRECATED)
+
+ /// Determine whether the address is a loopback address.
+ ASIO_DECL bool is_loopback() const;
+
+ /// Determine whether the address is unspecified.
+ ASIO_DECL bool is_unspecified() const;
+
+ /// Determine whether the address is link local.
+ ASIO_DECL bool is_link_local() const;
+
+ /// Determine whether the address is site local.
+ ASIO_DECL bool is_site_local() const;
+
+ /// Determine whether the address is a mapped IPv4 address.
+ ASIO_DECL bool is_v4_mapped() const;
+
+#if !defined(ASIO_NO_DEPRECATED)
+ /// (Deprecated: No replacement.) Determine whether the address is an
+ /// IPv4-compatible address.
+ ASIO_DECL bool is_v4_compatible() const;
+#endif // !defined(ASIO_NO_DEPRECATED)
+
+ /// Determine whether the address is a multicast address.
+ ASIO_DECL bool is_multicast() const;
+
+ /// Determine whether the address is a global multicast address.
+ ASIO_DECL bool is_multicast_global() const;
+
+ /// Determine whether the address is a link-local multicast address.
+ ASIO_DECL bool is_multicast_link_local() const;
+
+ /// Determine whether the address is a node-local multicast address.
+ ASIO_DECL bool is_multicast_node_local() const;
+
+ /// Determine whether the address is a org-local multicast address.
+ ASIO_DECL bool is_multicast_org_local() const;
+
+ /// Determine whether the address is a site-local multicast address.
+ ASIO_DECL bool is_multicast_site_local() const;
+
+ /// Compare two addresses for equality.
+ ASIO_DECL friend bool operator==(
+ const address_v6& a1, const address_v6& a2);
+
+ /// Compare two addresses for inequality.
+ friend bool operator!=(const address_v6& a1, const address_v6& a2)
+ {
+ return !(a1 == a2);
+ }
+
+ /// Compare addresses for ordering.
+ ASIO_DECL friend bool operator<(
+ const address_v6& a1, const address_v6& a2);
+
+ /// Compare addresses for ordering.
+ friend bool operator>(const address_v6& a1, const address_v6& a2)
+ {
+ return a2 < a1;
+ }
+
+ /// Compare addresses for ordering.
+ friend bool operator<=(const address_v6& a1, const address_v6& a2)
+ {
+ return !(a2 < a1);
+ }
+
+ /// Compare addresses for ordering.
+ friend bool operator>=(const address_v6& a1, const address_v6& a2)
+ {
+ return !(a1 < a2);
+ }
+
+ /// Obtain an address object that represents any address.
+ static address_v6 any()
+ {
+ return address_v6();
+ }
+
+ /// Obtain an address object that represents the loopback address.
+ ASIO_DECL static address_v6 loopback();
+
+#if !defined(ASIO_NO_DEPRECATED)
+ /// (Deprecated: Use make_address_v6().) Create an IPv4-mapped IPv6 address.
+ ASIO_DECL static address_v6 v4_mapped(const address_v4& addr);
+
+ /// (Deprecated: No replacement.) Create an IPv4-compatible IPv6 address.
+ 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_;
+};
+
+/// Create an IPv6 address from raw bytes and scope ID.
+/**
+ * @relates address_v6
+ */
+inline address_v6 make_address_v6(const address_v6::bytes_type& bytes,
+ unsigned long scope_id = 0)
+{
+ return address_v6(bytes, scope_id);
+}
+
+/// Create an IPv6 address from an IP address string.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(const char* str);
+
+/// Create an IPv6 address from an IP address string.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(
+ const char* str, asio::error_code& ec);
+
+/// Createan IPv6 address from an IP address string.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(const std::string& str);
+
+/// Create an IPv6 address from an IP address string.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(
+ const std::string& str, asio::error_code& ec);
+
+#if defined(ASIO_HAS_STRING_VIEW) \
+ || defined(GENERATING_DOCUMENTATION)
+
+/// Create an IPv6 address from an IP address string.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(string_view str);
+
+/// Create an IPv6 address from an IP address string.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(
+ string_view str, asio::error_code& ec);
+
+#endif // defined(ASIO_HAS_STRING_VIEW)
+ // || defined(GENERATING_DOCUMENTATION)
+
+/// Tag type used for distinguishing overloads that deal in IPv4-mapped IPv6
+/// addresses.
+enum v4_mapped_t { v4_mapped };
+
+/// Create an IPv4 address from a IPv4-mapped IPv6 address.
+/**
+ * @relates address_v4
+ */
+ASIO_DECL address_v4 make_address_v4(
+ v4_mapped_t, const address_v6& v6_addr);
+
+/// Create an IPv4-mapped IPv6 address from an IPv4 address.
+/**
+ * @relates address_v6
+ */
+ASIO_DECL address_v6 make_address_v6(
+ v4_mapped_t, const address_v4& v4_addr);
+
+#if !defined(ASIO_NO_IOSTREAM)
+
+/// Output an address as a string.
+/**
+ * Used to output a human-readable string for a specified address.
+ *
+ * @param os The output stream to which the string will be written.
+ *
+ * @param addr The address to be written.
+ *
+ * @return The output stream.
+ *
+ * @relates asio::ip::address_v6
+ */
+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