293 lines
7.5 KiB
C++
293 lines
7.5 KiB
C++
//
|
|
// address_v4.hpp
|
|
// ~~~~~~~~~~~~~~
|
|
//
|
|
// Copyright (c) 2003-2006 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/push_options.hpp"
|
|
|
|
#include "asio/detail/push_options.hpp"
|
|
#include <string>
|
|
#include <boost/array.hpp>
|
|
#include <boost/throw_exception.hpp>
|
|
#include "asio/detail/pop_options.hpp"
|
|
|
|
#include "asio/error.hpp"
|
|
#include "asio/error_handler.hpp"
|
|
#include "asio/detail/socket_ops.hpp"
|
|
#include "asio/detail/socket_types.hpp"
|
|
|
|
namespace asio {
|
|
namespace ip {
|
|
|
|
/// Implements IP version 4 style addresses.
|
|
/**
|
|
* The asio::ip::address_v4 class provides the ability to use and
|
|
* manipulate IP version 4 addresses.
|
|
*
|
|
* @par Thread Safety:
|
|
* @e Distinct @e objects: Safe.@n
|
|
* @e Shared @e objects: Unsafe.
|
|
*/
|
|
class address_v4
|
|
{
|
|
public:
|
|
/// The type used to represent an address as an array of bytes.
|
|
typedef boost::array<unsigned char, 4> bytes_type;
|
|
|
|
/// Default constructor.
|
|
address_v4()
|
|
{
|
|
addr_.s_addr = 0;
|
|
}
|
|
|
|
/// Construct an address from raw bytes.
|
|
explicit address_v4(const bytes_type& bytes)
|
|
{
|
|
using namespace std; // For memcpy.
|
|
memcpy(&addr_.s_addr, bytes.elems, 4);
|
|
}
|
|
|
|
/// Construct an address from a unsigned long in host byte order.
|
|
explicit address_v4(unsigned long addr)
|
|
{
|
|
addr_.s_addr = asio::detail::socket_ops::host_to_network_long(addr);
|
|
}
|
|
|
|
/// Copy constructor.
|
|
address_v4(const address_v4& other)
|
|
: addr_(other.addr_)
|
|
{
|
|
}
|
|
|
|
/// Assign from another address.
|
|
address_v4& operator=(const address_v4& other)
|
|
{
|
|
addr_ = other.addr_;
|
|
return *this;
|
|
}
|
|
|
|
/// Get the address in bytes.
|
|
bytes_type to_bytes() const
|
|
{
|
|
using namespace std; // For memcpy.
|
|
bytes_type bytes;
|
|
memcpy(bytes.elems, &addr_.s_addr, 4);
|
|
return bytes;
|
|
}
|
|
|
|
/// Get the address as an unsigned long in host byte order
|
|
unsigned long to_ulong() const
|
|
{
|
|
return asio::detail::socket_ops::network_to_host_long(addr_.s_addr);
|
|
}
|
|
|
|
/// Get the address as a string in dotted decimal format.
|
|
std::string to_string() const
|
|
{
|
|
return to_string(asio::throw_error());
|
|
}
|
|
|
|
/// Get the address as a string in dotted decimal format.
|
|
template <typename Error_Handler>
|
|
std::string to_string(Error_Handler error_handler) const
|
|
{
|
|
char addr_str[asio::detail::max_addr_v4_str_len];
|
|
const char* addr =
|
|
asio::detail::socket_ops::inet_ntop(AF_INET, &addr_, addr_str,
|
|
asio::detail::max_addr_v4_str_len);
|
|
if (addr == 0)
|
|
{
|
|
asio::error e(asio::detail::socket_ops::get_error());
|
|
error_handler(e);
|
|
return std::string();
|
|
}
|
|
asio::error e;
|
|
error_handler(e);
|
|
return addr;
|
|
}
|
|
|
|
/// Create an address from an IP address string in dotted decimal form.
|
|
static address_v4 from_string(const char* str)
|
|
{
|
|
return from_string(str, asio::throw_error());
|
|
}
|
|
|
|
/// Create an address from an IP address string in dotted decimal form.
|
|
template <typename Error_Handler>
|
|
static address_v4 from_string(const char* str, Error_Handler error_handler)
|
|
{
|
|
address_v4 tmp;
|
|
if (asio::detail::socket_ops::inet_pton(
|
|
AF_INET, str, &tmp.addr_) <= 0)
|
|
{
|
|
asio::error e(asio::detail::socket_ops::get_error());
|
|
error_handler(e);
|
|
return address_v4();
|
|
}
|
|
asio::error e;
|
|
error_handler(e);
|
|
return tmp;
|
|
}
|
|
|
|
/// Create an address from an IP address string in dotted decimal form.
|
|
static address_v4 from_string(const std::string& str)
|
|
{
|
|
return from_string(str.c_str(), asio::throw_error());
|
|
}
|
|
|
|
/// Create an address from an IP address string in dotted decimal form.
|
|
template <typename Error_Handler>
|
|
static address_v4 from_string(const std::string& str,
|
|
Error_Handler error_handler)
|
|
{
|
|
return from_string(str.c_str(), error_handler);
|
|
}
|
|
|
|
/// Determine whether the address is a class A address.
|
|
bool is_class_a() const
|
|
{
|
|
return IN_CLASSA(to_ulong());
|
|
}
|
|
|
|
/// Determine whether the address is a class B address.
|
|
bool is_class_b() const
|
|
{
|
|
return IN_CLASSB(to_ulong());
|
|
}
|
|
|
|
/// Determine whether the address is a class C address.
|
|
bool is_class_c() const
|
|
{
|
|
return IN_CLASSC(to_ulong());
|
|
}
|
|
|
|
/// Determine whether the address is a multicast address.
|
|
bool is_multicast() const
|
|
{
|
|
return IN_MULTICAST(to_ulong());
|
|
}
|
|
|
|
/// Compare two addresses for equality.
|
|
friend bool operator==(const address_v4& a1, const address_v4& a2)
|
|
{
|
|
return a1.addr_.s_addr == a2.addr_.s_addr;
|
|
}
|
|
|
|
/// Compare two addresses for inequality.
|
|
friend bool operator!=(const address_v4& a1, const address_v4& a2)
|
|
{
|
|
return a1.addr_.s_addr != a2.addr_.s_addr;
|
|
}
|
|
|
|
/// Compare addresses for ordering.
|
|
friend bool operator<(const address_v4& a1, const address_v4& a2)
|
|
{
|
|
return a1.to_ulong() < a2.to_ulong();
|
|
}
|
|
|
|
/// Compare addresses for ordering.
|
|
friend bool operator>(const address_v4& a1, const address_v4& a2)
|
|
{
|
|
return a1.to_ulong() > a2.to_ulong();
|
|
}
|
|
|
|
/// Compare addresses for ordering.
|
|
friend bool operator<=(const address_v4& a1, const address_v4& a2)
|
|
{
|
|
return a1.to_ulong() <= a2.to_ulong();
|
|
}
|
|
|
|
/// Compare addresses for ordering.
|
|
friend bool operator>=(const address_v4& a1, const address_v4& a2)
|
|
{
|
|
return a1.to_ulong() >= a2.to_ulong();
|
|
}
|
|
|
|
/// Obtain an address object that represents any address.
|
|
static address_v4 any()
|
|
{
|
|
return address_v4(static_cast<unsigned long>(INADDR_ANY));
|
|
}
|
|
|
|
/// Obtain an address object that represents the loopback address.
|
|
static address_v4 loopback()
|
|
{
|
|
return address_v4(static_cast<unsigned long>(INADDR_LOOPBACK));
|
|
}
|
|
|
|
/// Obtain an address object that represents the broadcast address.
|
|
static address_v4 broadcast()
|
|
{
|
|
return address_v4(static_cast<unsigned long>(INADDR_BROADCAST));
|
|
}
|
|
|
|
/// Obtain an address object that represents the broadcast address that
|
|
/// corresponds to the specified address and netmask.
|
|
static address_v4 broadcast(const address_v4& addr, const address_v4& mask)
|
|
{
|
|
return address_v4(addr.to_ulong() | ~mask.to_ulong());
|
|
}
|
|
|
|
/// Obtain the netmask that corresponds to the address, based on its address
|
|
/// class.
|
|
static address_v4 netmask(const address_v4& addr)
|
|
{
|
|
if (addr.is_class_a())
|
|
return address_v4(0xFF000000);
|
|
if (addr.is_class_b())
|
|
return address_v4(0xFFFF0000);
|
|
if (addr.is_class_c())
|
|
return address_v4(0xFFFFFF00);
|
|
return address_v4(0xFFFFFFFF);
|
|
}
|
|
|
|
private:
|
|
// The underlying IPv4 address.
|
|
asio::detail::in4_addr_type addr_;
|
|
};
|
|
|
|
/// 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_v4
|
|
*/
|
|
template <typename Elem, typename Traits>
|
|
std::basic_ostream<Elem, Traits>& operator<<(
|
|
std::basic_ostream<Elem, Traits>& os, const address_v4& addr)
|
|
{
|
|
asio::error e;
|
|
std::string s = addr.to_string(asio::assign_error(e));
|
|
if (e)
|
|
os.setstate(std::ios_base::failbit);
|
|
else
|
|
for (std::string::iterator i = s.begin(); i != s.end(); ++i)
|
|
os << os.widen(*i);
|
|
return os;
|
|
}
|
|
|
|
} // namespace ip
|
|
} // namespace asio
|
|
|
|
#include "asio/detail/pop_options.hpp"
|
|
|
|
#endif // ASIO_IP_ADDRESS_V4_HPP
|