. /include/boost/corosio /tcp.hpp
100.00% Lines (7/7) 100.00% Functions (4/4)
[ ] prev/next file n p prev/next uncovered line
TLA Baseline Branch
Line Hits Code Line Hits Code
1   // 1   //
2   // Copyright (c) 2026 Steve Gerbino 2   // Copyright (c) 2026 Steve Gerbino
3   // 3   //
4   // Distributed under the Boost Software License, Version 1.0. (See accompanying 4   // Distributed under the Boost Software License, Version 1.0. (See accompanying
5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6   // 6   //
7   // Official repository: https://github.com/cppalliance/corosio 7   // Official repository: https://github.com/cppalliance/corosio
8   // 8   //
9   9  
10   #ifndef BOOST_COROSIO_TCP_HPP 10   #ifndef BOOST_COROSIO_TCP_HPP
11   #define BOOST_COROSIO_TCP_HPP 11   #define BOOST_COROSIO_TCP_HPP
12   12  
13   #include <boost/corosio/detail/config.hpp> 13   #include <boost/corosio/detail/config.hpp>
14   14  
15   namespace boost::corosio { 15   namespace boost::corosio {
16   16  
17   class tcp_socket; 17   class tcp_socket;
18   class tcp_acceptor; 18   class tcp_acceptor;
19   19  
20   /** Encapsulate the TCP protocol for socket creation. 20   /** Encapsulate the TCP protocol for socket creation.
21   21  
22   This class identifies the TCP protocol and its address family 22   This class identifies the TCP protocol and its address family
23   (IPv4 or IPv6). It is used to parameterize socket and acceptor 23   (IPv4 or IPv6). It is used to parameterize socket and acceptor
24   `open()` calls with a self-documenting type. 24   `open()` calls with a self-documenting type.
25   25  
26 - The `family()`, `type()`, and `protocol()` members return the 26 + The `family()`, `type()`, and `protocol()` members are
27 - three integers passed to the operating system's `socket()` 27 + implemented in the compiled library to avoid exposing
28 - call. Their values are platform-defined constants taken from 28 + platform socket headers. For an inline variant that includes
29 - the system socket headers. For an inline variant that includes 29 + platform headers, use @ref native_tcp.
30 - those headers, use @ref native_tcp.  
31   30  
32   @par Example 31   @par Example
33   @code 32   @code
34   tcp_acceptor acc( ioc ); 33   tcp_acceptor acc( ioc );
35   acc.open( tcp::v6() ); // IPv6 socket 34   acc.open( tcp::v6() ); // IPv6 socket
36   acc.set_option( socket_option::reuse_address( true ) ); 35   acc.set_option( socket_option::reuse_address( true ) );
37   acc.bind( endpoint( ipv6_address::any(), 8080 ) ); 36   acc.bind( endpoint( ipv6_address::any(), 8080 ) );
38   acc.listen(); 37   acc.listen();
39   @endcode 38   @endcode
40   39  
41   @see native_tcp, tcp_socket, tcp_acceptor 40   @see native_tcp, tcp_socket, tcp_acceptor
42   */ 41   */
43   class BOOST_COROSIO_DECL tcp 42   class BOOST_COROSIO_DECL tcp
44   { 43   {
45   bool v6_; 44   bool v6_;
HITCBC 46   8322 explicit constexpr tcp(bool v6) noexcept : v6_(v6) {} 45   7673 explicit constexpr tcp(bool v6) noexcept : v6_(v6) {}
47   46  
48   public: 47   public:
49   /// Construct an IPv4 TCP protocol. 48   /// Construct an IPv4 TCP protocol.
HITCBC 50   8274 static constexpr tcp v4() noexcept 49   7625 static constexpr tcp v4() noexcept
51   { 50   {
HITCBC 52   8274 return tcp(false); 51   7625 return tcp(false);
53   } 52   }
54   53  
55   /// Construct an IPv6 TCP protocol. 54   /// Construct an IPv6 TCP protocol.
HITCBC 56   48 static constexpr tcp v6() noexcept 55   48 static constexpr tcp v6() noexcept
57   { 56   {
HITCBC 58   48 return tcp(true); 57   48 return tcp(true);
59   } 58   }
60   59  
61   /// Return true if this is IPv6. 60   /// Return true if this is IPv6.
62   constexpr bool is_v6() const noexcept 61   constexpr bool is_v6() const noexcept
63   { 62   {
64   return v6_; 63   return v6_;
65   } 64   }
66   65  
67   /// Return the address family (AF_INET or AF_INET6). 66   /// Return the address family (AF_INET or AF_INET6).
68   int family() const noexcept; 67   int family() const noexcept;
69   68  
70   /// Return the socket type (SOCK_STREAM). 69   /// Return the socket type (SOCK_STREAM).
71   static int type() noexcept; 70   static int type() noexcept;
72   71  
73   /// Return the IP protocol (IPPROTO_TCP). 72   /// Return the IP protocol (IPPROTO_TCP).
74   static int protocol() noexcept; 73   static int protocol() noexcept;
75   74  
76 - /// The socket type to use with this protocol, @ref tcp_socket. 75 + /// The associated socket type.
77   using socket = tcp_socket; 76   using socket = tcp_socket;
78   77  
79 - /// The acceptor type to use with this protocol, @ref tcp_acceptor. 78 + /// The associated acceptor type.
80   using acceptor = tcp_acceptor; 79   using acceptor = tcp_acceptor;
81   80  
82   /// Test for equality. 81   /// Test for equality.
HITCBC 83   12 friend constexpr bool operator==(tcp a, tcp b) noexcept 82   12 friend constexpr bool operator==(tcp a, tcp b) noexcept
84   { 83   {
HITCBC 85   12 return a.v6_ == b.v6_; 84   12 return a.v6_ == b.v6_;
86   } 85   }
87   86  
88   /// Test for inequality. 87   /// Test for inequality.
89   friend constexpr bool operator!=(tcp a, tcp b) noexcept 88   friend constexpr bool operator!=(tcp a, tcp b) noexcept
90   { 89   {
91   return a.v6_ != b.v6_; 90   return a.v6_ != b.v6_;
92   } 91   }
93   }; 92   };
94   93  
95   } // namespace boost::corosio 94   } // namespace boost::corosio
96   95  
97   #endif // BOOST_COROSIO_TCP_HPP 96   #endif // BOOST_COROSIO_TCP_HPP