// | |
// ip/icmp.hpp | |
// ~~~~~~~~~~~ | |
// | |
// Copyright (c) 2003-2011 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_ICMP_HPP | |
#define BOOST_ASIO_IP_ICMP_HPP | |
#if defined(_MSC_VER) && (_MSC_VER >= 1200) | |
# pragma once | |
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200) | |
#include <boost/asio/detail/config.hpp> | |
#include <boost/asio/detail/socket_types.hpp> | |
#include <boost/asio/basic_raw_socket.hpp> | |
#include <boost/asio/ip/basic_endpoint.hpp> | |
#include <boost/asio/ip/basic_resolver.hpp> | |
#include <boost/asio/ip/basic_resolver_iterator.hpp> | |
#include <boost/asio/ip/basic_resolver_query.hpp> | |
#include <boost/asio/detail/push_options.hpp> | |
namespace boost { | |
namespace asio { | |
namespace ip { | |
/// Encapsulates the flags needed for ICMP. | |
/** | |
* The boost::asio::ip::icmp class contains flags necessary for ICMP sockets. | |
* | |
* @par Thread Safety | |
* @e Distinct @e objects: Safe.@n | |
* @e Shared @e objects: Safe. | |
* | |
* @par Concepts: | |
* Protocol, InternetProtocol. | |
*/ | |
class icmp | |
{ | |
public: | |
/// The type of a ICMP endpoint. | |
typedef basic_endpoint<icmp> endpoint; | |
/// (Deprecated: use resolver::query.) The type of a resolver query. | |
typedef basic_resolver_query<icmp> resolver_query; | |
/// (Deprecated: use resolver::iterator.) The type of a resolver iterator. | |
typedef basic_resolver_iterator<icmp> resolver_iterator; | |
/// Construct to represent the IPv4 ICMP protocol. | |
static icmp v4() | |
{ | |
return icmp(IPPROTO_ICMP, PF_INET); | |
} | |
/// Construct to represent the IPv6 ICMP protocol. | |
static icmp v6() | |
{ | |
return icmp(IPPROTO_ICMPV6, PF_INET6); | |
} | |
/// Obtain an identifier for the type of the protocol. | |
int type() const | |
{ | |
return SOCK_RAW; | |
} | |
/// Obtain an identifier for the protocol. | |
int protocol() const | |
{ | |
return protocol_; | |
} | |
/// Obtain an identifier for the protocol family. | |
int family() const | |
{ | |
return family_; | |
} | |
/// The ICMP socket type. | |
typedef basic_raw_socket<icmp> socket; | |
/// The ICMP resolver type. | |
typedef basic_resolver<icmp> resolver; | |
/// Compare two protocols for equality. | |
friend bool operator==(const icmp& p1, const icmp& p2) | |
{ | |
return p1.protocol_ == p2.protocol_ && p1.family_ == p2.family_; | |
} | |
/// Compare two protocols for inequality. | |
friend bool operator!=(const icmp& p1, const icmp& p2) | |
{ | |
return p1.protocol_ != p2.protocol_ || p1.family_ != p2.family_; | |
} | |
private: | |
// Construct with a specific family. | |
explicit icmp(int protocol, int family) | |
: protocol_(protocol), | |
family_(family) | |
{ | |
} | |
int protocol_; | |
int family_; | |
}; | |
} // namespace ip | |
} // namespace asio | |
} // namespace boost | |
#include <boost/asio/detail/pop_options.hpp> | |
#endif // BOOST_ASIO_IP_ICMP_HPP |