| // |
| // ip/address.hpp |
| // ~~~~~~~~~~~~~~ |
| // |
| // Copyright (c) 2003-2010 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 BOOST_ASIO_IP_ADDRESS_HPP |
| #define BOOST_ASIO_IP_ADDRESS_HPP |
| |
| #if defined(_MSC_VER) && (_MSC_VER >= 1200) |
| # pragma once |
| #endif // defined(_MSC_VER) && (_MSC_VER >= 1200) |
| |
| #include <boost/asio/detail/config.hpp> |
| #include <string> |
| #include <boost/system/error_code.hpp> |
| #include <boost/asio/ip/address_v4.hpp> |
| #include <boost/asio/ip/address_v6.hpp> |
| |
| #if !defined(BOOST_NO_IOSTREAM) |
| # include <iosfwd> |
| #endif // !defined(BOOST_NO_IOSTREAM) |
| |
| #include <boost/asio/detail/push_options.hpp> |
| |
| namespace boost { |
| namespace asio { |
| namespace ip { |
| |
| /// Implements version-independent IP addresses. |
| /** |
| * The boost::asio::ip::address class provides the ability to use either IP |
| * version 4 or version 6 addresses. |
| * |
| * @par Thread Safety |
| * @e Distinct @e objects: Safe.@n |
| * @e Shared @e objects: Unsafe. |
| */ |
| class address |
| { |
| public: |
| /// Default constructor. |
| BOOST_ASIO_DECL address(); |
| |
| /// Construct an address from an IPv4 address. |
| BOOST_ASIO_DECL address(const boost::asio::ip::address_v4& ipv4_address); |
| |
| /// Construct an address from an IPv6 address. |
| BOOST_ASIO_DECL address(const boost::asio::ip::address_v6& ipv6_address); |
| |
| /// Copy constructor. |
| BOOST_ASIO_DECL address(const address& other); |
| |
| /// Assign from another address. |
| BOOST_ASIO_DECL address& operator=(const address& other); |
| |
| /// Assign from an IPv4 address. |
| BOOST_ASIO_DECL address& operator=( |
| const boost::asio::ip::address_v4& ipv4_address); |
| |
| /// Assign from an IPv6 address. |
| BOOST_ASIO_DECL address& operator=( |
| const boost::asio::ip::address_v6& ipv6_address); |
| |
| /// Get whether the address is an IP version 4 address. |
| bool is_v4() const |
| { |
| return type_ == ipv4; |
| } |
| |
| /// Get whether the address is an IP version 6 address. |
| bool is_v6() const |
| { |
| return type_ == ipv6; |
| } |
| |
| /// Get the address as an IP version 4 address. |
| BOOST_ASIO_DECL boost::asio::ip::address_v4 to_v4() const; |
| |
| /// Get the address as an IP version 6 address. |
| BOOST_ASIO_DECL boost::asio::ip::address_v6 to_v6() const; |
| |
| /// Get the address as a string in dotted decimal format. |
| BOOST_ASIO_DECL std::string to_string() const; |
| |
| /// Get the address as a string in dotted decimal format. |
| BOOST_ASIO_DECL std::string to_string(boost::system::error_code& ec) const; |
| |
| /// Create an address from an IPv4 address string in dotted decimal form, |
| /// or from an IPv6 address in hexadecimal notation. |
| BOOST_ASIO_DECL static address from_string(const char* str); |
| |
| /// Create an address from an IPv4 address string in dotted decimal form, |
| /// or from an IPv6 address in hexadecimal notation. |
| BOOST_ASIO_DECL static address from_string( |
| const char* str, boost::system::error_code& ec); |
| |
| /// Create an address from an IPv4 address string in dotted decimal form, |
| /// or from an IPv6 address in hexadecimal notation. |
| BOOST_ASIO_DECL static address from_string(const std::string& str); |
| |
| /// Create an address from an IPv4 address string in dotted decimal form, |
| /// or from an IPv6 address in hexadecimal notation. |
| BOOST_ASIO_DECL static address from_string( |
| const std::string& str, boost::system::error_code& ec); |
| |
| /// Compare two addresses for equality. |
| BOOST_ASIO_DECL friend bool operator==(const address& a1, const address& a2); |
| |
| /// Compare two addresses for inequality. |
| friend bool operator!=(const address& a1, const address& a2) |
| { |
| return !(a1 == a2); |
| } |
| |
| /// Compare addresses for ordering. |
| BOOST_ASIO_DECL friend bool operator<(const address& a1, const address& a2); |
| |
| /// Compare addresses for ordering. |
| friend bool operator>(const address& a1, const address& a2) |
| { |
| return a2 < a1; |
| } |
| |
| /// Compare addresses for ordering. |
| friend bool operator<=(const address& a1, const address& a2) |
| { |
| return !(a2 < a1); |
| } |
| |
| /// Compare addresses for ordering. |
| friend bool operator>=(const address& a1, const address& a2) |
| { |
| return !(a1 < a2); |
| } |
| |
| private: |
| // The type of the address. |
| enum { ipv4, ipv6 } type_; |
| |
| // The underlying IPv4 address. |
| boost::asio::ip::address_v4 ipv4_address_; |
| |
| // The underlying IPv6 address. |
| boost::asio::ip::address_v6 ipv6_address_; |
| }; |
| |
| #if !defined(BOOST_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 boost::asio::ip::address |
| */ |
| template <typename Elem, typename Traits> |
| std::basic_ostream<Elem, Traits>& operator<<( |
| std::basic_ostream<Elem, Traits>& os, const address& addr); |
| |
| #endif // !defined(BOOST_NO_IOSTREAM) |
| |
| } // namespace ip |
| } // namespace asio |
| } // namespace boost |
| |
| #include <boost/asio/detail/pop_options.hpp> |
| |
| #include <boost/asio/ip/impl/address.hpp> |
| #if defined(BOOST_ASIO_HEADER_ONLY) |
| # include <boost/asio/ip/impl/address.ipp> |
| #endif // defined(BOOST_ASIO_HEADER_ONLY) |
| |
| #endif // BOOST_ASIO_IP_ADDRESS_HPP |