annotate DEPENDENCIES/generic/include/boost/asio/ip/tcp.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/tcp.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_TCP_HPP
Chris@16 12 #define BOOST_ASIO_IP_TCP_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/basic_socket_acceptor.hpp>
Chris@16 20 #include <boost/asio/basic_socket_iostream.hpp>
Chris@16 21 #include <boost/asio/basic_stream_socket.hpp>
Chris@16 22 #include <boost/asio/detail/socket_option.hpp>
Chris@16 23 #include <boost/asio/detail/socket_types.hpp>
Chris@16 24 #include <boost/asio/ip/basic_endpoint.hpp>
Chris@16 25 #include <boost/asio/ip/basic_resolver.hpp>
Chris@16 26 #include <boost/asio/ip/basic_resolver_iterator.hpp>
Chris@16 27 #include <boost/asio/ip/basic_resolver_query.hpp>
Chris@16 28
Chris@16 29 #include <boost/asio/detail/push_options.hpp>
Chris@16 30
Chris@16 31 namespace boost {
Chris@16 32 namespace asio {
Chris@16 33 namespace ip {
Chris@16 34
Chris@16 35 /// Encapsulates the flags needed for TCP.
Chris@16 36 /**
Chris@16 37 * The boost::asio::ip::tcp class contains flags necessary for TCP sockets.
Chris@16 38 *
Chris@16 39 * @par Thread Safety
Chris@16 40 * @e Distinct @e objects: Safe.@n
Chris@16 41 * @e Shared @e objects: Safe.
Chris@16 42 *
Chris@16 43 * @par Concepts:
Chris@16 44 * Protocol, InternetProtocol.
Chris@16 45 */
Chris@16 46 class tcp
Chris@16 47 {
Chris@16 48 public:
Chris@16 49 /// The type of a TCP endpoint.
Chris@16 50 typedef basic_endpoint<tcp> endpoint;
Chris@16 51
Chris@16 52 /// Construct to represent the IPv4 TCP protocol.
Chris@16 53 static tcp v4()
Chris@16 54 {
Chris@16 55 return tcp(BOOST_ASIO_OS_DEF(AF_INET));
Chris@16 56 }
Chris@16 57
Chris@16 58 /// Construct to represent the IPv6 TCP protocol.
Chris@16 59 static tcp v6()
Chris@16 60 {
Chris@16 61 return tcp(BOOST_ASIO_OS_DEF(AF_INET6));
Chris@16 62 }
Chris@16 63
Chris@16 64 /// Obtain an identifier for the type of the protocol.
Chris@16 65 int type() const
Chris@16 66 {
Chris@16 67 return BOOST_ASIO_OS_DEF(SOCK_STREAM);
Chris@16 68 }
Chris@16 69
Chris@16 70 /// Obtain an identifier for the protocol.
Chris@16 71 int protocol() const
Chris@16 72 {
Chris@16 73 return BOOST_ASIO_OS_DEF(IPPROTO_TCP);
Chris@16 74 }
Chris@16 75
Chris@16 76 /// Obtain an identifier for the protocol family.
Chris@16 77 int family() const
Chris@16 78 {
Chris@16 79 return family_;
Chris@16 80 }
Chris@16 81
Chris@16 82 /// The TCP socket type.
Chris@16 83 typedef basic_stream_socket<tcp> socket;
Chris@16 84
Chris@16 85 /// The TCP acceptor type.
Chris@16 86 typedef basic_socket_acceptor<tcp> acceptor;
Chris@16 87
Chris@16 88 /// The TCP resolver type.
Chris@16 89 typedef basic_resolver<tcp> resolver;
Chris@16 90
Chris@16 91 #if !defined(BOOST_ASIO_NO_IOSTREAM)
Chris@16 92 /// The TCP iostream type.
Chris@16 93 typedef basic_socket_iostream<tcp> iostream;
Chris@16 94 #endif // !defined(BOOST_ASIO_NO_IOSTREAM)
Chris@16 95
Chris@16 96 /// Socket option for disabling the Nagle algorithm.
Chris@16 97 /**
Chris@16 98 * Implements the IPPROTO_TCP/TCP_NODELAY socket option.
Chris@16 99 *
Chris@16 100 * @par Examples
Chris@16 101 * Setting the option:
Chris@16 102 * @code
Chris@16 103 * boost::asio::ip::tcp::socket socket(io_service);
Chris@16 104 * ...
Chris@16 105 * boost::asio::ip::tcp::no_delay option(true);
Chris@16 106 * socket.set_option(option);
Chris@16 107 * @endcode
Chris@16 108 *
Chris@16 109 * @par
Chris@16 110 * Getting the current option value:
Chris@16 111 * @code
Chris@16 112 * boost::asio::ip::tcp::socket socket(io_service);
Chris@16 113 * ...
Chris@16 114 * boost::asio::ip::tcp::no_delay option;
Chris@16 115 * socket.get_option(option);
Chris@16 116 * bool is_set = option.value();
Chris@16 117 * @endcode
Chris@16 118 *
Chris@16 119 * @par Concepts:
Chris@16 120 * Socket_Option, Boolean_Socket_Option.
Chris@16 121 */
Chris@16 122 #if defined(GENERATING_DOCUMENTATION)
Chris@16 123 typedef implementation_defined no_delay;
Chris@16 124 #else
Chris@16 125 typedef boost::asio::detail::socket_option::boolean<
Chris@16 126 BOOST_ASIO_OS_DEF(IPPROTO_TCP), BOOST_ASIO_OS_DEF(TCP_NODELAY)> no_delay;
Chris@16 127 #endif
Chris@16 128
Chris@16 129 /// Compare two protocols for equality.
Chris@16 130 friend bool operator==(const tcp& p1, const tcp& p2)
Chris@16 131 {
Chris@16 132 return p1.family_ == p2.family_;
Chris@16 133 }
Chris@16 134
Chris@16 135 /// Compare two protocols for inequality.
Chris@16 136 friend bool operator!=(const tcp& p1, const tcp& p2)
Chris@16 137 {
Chris@16 138 return p1.family_ != p2.family_;
Chris@16 139 }
Chris@16 140
Chris@16 141 private:
Chris@16 142 // Construct with a specific family.
Chris@16 143 explicit tcp(int protocol_family)
Chris@16 144 : family_(protocol_family)
Chris@16 145 {
Chris@16 146 }
Chris@16 147
Chris@16 148 int family_;
Chris@16 149 };
Chris@16 150
Chris@16 151 } // namespace ip
Chris@16 152 } // namespace asio
Chris@16 153 } // namespace boost
Chris@16 154
Chris@16 155 #include <boost/asio/detail/pop_options.hpp>
Chris@16 156
Chris@16 157 #endif // BOOST_ASIO_IP_TCP_HPP