annotate DEPENDENCIES/generic/include/boost/asio/ip/v6_only.hpp @ 133:4acb5d8d80b6 tip

Don't fail environmental check if README.md exists (but .txt and no-suffix don't)
author Chris Cannam
date Tue, 30 Jul 2019 12:25:44 +0100
parents c530137014c0
children
rev   line source
Chris@16 1 //
Chris@16 2 // ip/v6_only.hpp
Chris@16 3 // ~~~~~~~~~~~~~~
Chris@16 4 //
Chris@101 5 // Copyright (c) 2003-2015 Christopher M. Kohlhoff (chris at kohlhoff dot com)
Chris@16 6 //
Chris@16 7 // Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16 8 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16 9 //
Chris@16 10
Chris@16 11 #ifndef BOOST_ASIO_IP_V6_ONLY_HPP
Chris@16 12 #define BOOST_ASIO_IP_V6_ONLY_HPP
Chris@16 13
Chris@16 14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16 15 # pragma once
Chris@16 16 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16 17
Chris@16 18 #include <boost/asio/detail/config.hpp>
Chris@16 19 #include <boost/asio/detail/socket_option.hpp>
Chris@16 20
Chris@16 21 #include <boost/asio/detail/push_options.hpp>
Chris@16 22
Chris@16 23 namespace boost {
Chris@16 24 namespace asio {
Chris@16 25 namespace ip {
Chris@16 26
Chris@16 27 /// Socket option for determining whether an IPv6 socket supports IPv6
Chris@16 28 /// communication only.
Chris@16 29 /**
Chris@16 30 * Implements the IPPROTO_IPV6/IP_V6ONLY socket option.
Chris@16 31 *
Chris@16 32 * @par Examples
Chris@16 33 * Setting the option:
Chris@16 34 * @code
Chris@16 35 * boost::asio::ip::tcp::socket socket(io_service);
Chris@16 36 * ...
Chris@16 37 * boost::asio::ip::v6_only option(true);
Chris@16 38 * socket.set_option(option);
Chris@16 39 * @endcode
Chris@16 40 *
Chris@16 41 * @par
Chris@16 42 * Getting the current option value:
Chris@16 43 * @code
Chris@16 44 * boost::asio::ip::tcp::socket socket(io_service);
Chris@16 45 * ...
Chris@16 46 * boost::asio::ip::v6_only option;
Chris@16 47 * socket.get_option(option);
Chris@16 48 * bool v6_only = option.value();
Chris@16 49 * @endcode
Chris@16 50 *
Chris@16 51 * @par Concepts:
Chris@16 52 * GettableSocketOption, SettableSocketOption.
Chris@16 53 */
Chris@16 54 #if defined(GENERATING_DOCUMENTATION)
Chris@16 55 typedef implementation_defined v6_only;
Chris@16 56 #elif defined(IPV6_V6ONLY)
Chris@16 57 typedef boost::asio::detail::socket_option::boolean<
Chris@16 58 IPPROTO_IPV6, IPV6_V6ONLY> v6_only;
Chris@16 59 #else
Chris@16 60 typedef boost::asio::detail::socket_option::boolean<
Chris@16 61 boost::asio::detail::custom_socket_option_level,
Chris@16 62 boost::asio::detail::always_fail_option> v6_only;
Chris@16 63 #endif
Chris@16 64
Chris@16 65 } // namespace ip
Chris@16 66 } // namespace asio
Chris@16 67 } // namespace boost
Chris@16 68
Chris@16 69 #include <boost/asio/detail/pop_options.hpp>
Chris@16 70
Chris@16 71 #endif // BOOST_ASIO_IP_V6_ONLY_HPP