1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_stream_socket::native_non_blocking (3 of 3 overloads)</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../native_non_blocking.html" title="basic_stream_socket::native_non_blocking"> 9<link rel="prev" href="overload2.html" title="basic_stream_socket::native_non_blocking (2 of 3 overloads)"> 10<link rel="next" href="../non_blocking.html" title="basic_stream_socket::non_blocking"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../non_blocking.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="boost_asio.reference.basic_stream_socket.native_non_blocking.overload3"></a><a class="link" href="overload3.html" title="basic_stream_socket::native_non_blocking (3 of 3 overloads)">basic_stream_socket::native_non_blocking 28 (3 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 <span class="emphasis"><em>Inherited from basic_socket.</em></span> 32 </p> 33<p> 34 Sets the non-blocking mode of the native socket implementation. 35 </p> 36<pre class="programlisting">void native_non_blocking( 37 bool mode, 38 boost::system::error_code & ec); 39</pre> 40<p> 41 This function is used to modify the non-blocking mode of the underlying 42 native socket. It has no effect on the behaviour of the socket object's 43 synchronous operations. 44 </p> 45<h6> 46<a name="boost_asio.reference.basic_stream_socket.native_non_blocking.overload3.h0"></a> 47 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.native_non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_stream_socket.native_non_blocking.overload3.parameters">Parameters</a> 48 </h6> 49<div class="variablelist"> 50<p class="title"><b></b></p> 51<dl class="variablelist"> 52<dt><span class="term">mode</span></dt> 53<dd><p> 54 If <code class="computeroutput">true</code>, the underlying socket is put into non-blocking 55 mode and direct system calls may fail with <code class="computeroutput">boost::asio::error::would_block</code> 56 (or the equivalent system error). 57 </p></dd> 58<dt><span class="term">ec</span></dt> 59<dd><p> 60 Set to indicate what error occurred, if any. If the <code class="computeroutput">mode</code> 61 is <code class="computeroutput">false</code>, but the current value of <code class="computeroutput">non_blocking()</code> 62 is <code class="computeroutput">true</code>, this function fails with <code class="computeroutput">boost::asio::error::invalid_argument</code>, 63 as the combination does not make sense. 64 </p></dd> 65</dl> 66</div> 67<h6> 68<a name="boost_asio.reference.basic_stream_socket.native_non_blocking.overload3.h1"></a> 69 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.native_non_blocking.overload3.example"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_stream_socket.native_non_blocking.overload3.example">Example</a> 70 </h6> 71<p> 72 This function is intended to allow the encapsulation of arbitrary non-blocking 73 system calls as asynchronous operations, in a way that is transparent 74 to the user of the socket object. The following example illustrates how 75 Linux's <code class="computeroutput">sendfile</code> system call might be encapsulated: 76 </p> 77<pre class="programlisting">template <typename Handler> 78struct sendfile_op 79{ 80 tcp::socket& sock_; 81 int fd_; 82 Handler handler_; 83 off_t offset_; 84 std::size_t total_bytes_transferred_; 85 86 // Function call operator meeting WriteHandler requirements. 87 // Used as the handler for the async_write_some operation. 88 void operator()(boost::system::error_code ec, std::size_t) 89 { 90 // Put the underlying socket into non-blocking mode. 91 if (!ec) 92 if (!sock_.native_non_blocking()) 93 sock_.native_non_blocking(true, ec); 94 95 if (!ec) 96 { 97 for (;;) 98 { 99 // Try the system call. 100 errno = 0; 101 int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536); 102 ec = boost::system::error_code(n < 0 ? errno : 0, 103 boost::asio::error::get_system_category()); 104 total_bytes_transferred_ += ec ? 0 : n; 105 106 // Retry operation immediately if interrupted by signal. 107 if (ec == boost::asio::error::interrupted) 108 continue; 109 110 // Check if we need to run the operation again. 111 if (ec == boost::asio::error::would_block 112 || ec == boost::asio::error::try_again) 113 { 114 // We have to wait for the socket to become ready again. 115 sock_.async_wait(tcp::socket::wait_write, *this); 116 return; 117 } 118 119 if (ec || n == 0) 120 { 121 // An error occurred, or we have reached the end of the file. 122 // Either way we must exit the loop so we can call the handler. 123 break; 124 } 125 126 // Loop around to try calling sendfile again. 127 } 128 } 129 130 // Pass result back to user's handler. 131 handler_(ec, total_bytes_transferred_); 132 } 133}; 134 135template <typename Handler> 136void async_sendfile(tcp::socket& sock, int fd, Handler h) 137{ 138 sendfile_op<Handler> op = { sock, fd, h, 0, 0 }; 139 sock.async_wait(tcp::socket::wait_write, op); 140} 141</pre> 142</div> 143<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 144<td align="left"></td> 145<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 146 Kohlhoff<p> 147 Distributed under the Boost Software License, Version 1.0. (See accompanying 148 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 149 </p> 150</div></td> 151</tr></table> 152<hr> 153<div class="spirit-nav"> 154<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../non_blocking.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 155</div> 156</body> 157</html> 158
