annotate DEPENDENCIES/generic/include/boost/asio/ip/unicast.hpp @ 125:34e428693f5d vext

Vext -> Repoint
author Chris Cannam
date Thu, 14 Jun 2018 11:15:39 +0100
parents c530137014c0
children
rev   line source
Chris@16 1 //
Chris@16 2 // ip/unicast.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_UNICAST_HPP
Chris@16 12 #define BOOST_ASIO_IP_UNICAST_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 <cstddef>
Chris@16 20 #include <boost/asio/ip/detail/socket_option.hpp>
Chris@16 21
Chris@16 22 #include <boost/asio/detail/push_options.hpp>
Chris@16 23
Chris@16 24 namespace boost {
Chris@16 25 namespace asio {
Chris@16 26 namespace ip {
Chris@16 27 namespace unicast {
Chris@16 28
Chris@16 29 /// Socket option for time-to-live associated with outgoing unicast packets.
Chris@16 30 /**
Chris@16 31 * Implements the IPPROTO_IP/IP_UNICAST_TTL socket option.
Chris@16 32 *
Chris@16 33 * @par Examples
Chris@16 34 * Setting the option:
Chris@16 35 * @code
Chris@16 36 * boost::asio::ip::udp::socket socket(io_service);
Chris@16 37 * ...
Chris@16 38 * boost::asio::ip::unicast::hops option(4);
Chris@16 39 * socket.set_option(option);
Chris@16 40 * @endcode
Chris@16 41 *
Chris@16 42 * @par
Chris@16 43 * Getting the current option value:
Chris@16 44 * @code
Chris@16 45 * boost::asio::ip::udp::socket socket(io_service);
Chris@16 46 * ...
Chris@16 47 * boost::asio::ip::unicast::hops option;
Chris@16 48 * socket.get_option(option);
Chris@16 49 * int ttl = option.value();
Chris@16 50 * @endcode
Chris@16 51 *
Chris@16 52 * @par Concepts:
Chris@16 53 * GettableSocketOption, SettableSocketOption.
Chris@16 54 */
Chris@16 55 #if defined(GENERATING_DOCUMENTATION)
Chris@16 56 typedef implementation_defined hops;
Chris@16 57 #else
Chris@16 58 typedef boost::asio::ip::detail::socket_option::unicast_hops<
Chris@16 59 BOOST_ASIO_OS_DEF(IPPROTO_IP),
Chris@16 60 BOOST_ASIO_OS_DEF(IP_TTL),
Chris@16 61 BOOST_ASIO_OS_DEF(IPPROTO_IPV6),
Chris@16 62 BOOST_ASIO_OS_DEF(IPV6_UNICAST_HOPS)> hops;
Chris@16 63 #endif
Chris@16 64
Chris@16 65 } // namespace unicast
Chris@16 66 } // namespace ip
Chris@16 67 } // namespace asio
Chris@16 68 } // namespace boost
Chris@16 69
Chris@16 70 #include <boost/asio/detail/pop_options.hpp>
Chris@16 71
Chris@16 72 #endif // BOOST_ASIO_IP_UNICAST_HPP