doc/html/boost_asio/reference/basic_stream_socket/async_send/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream_socket::async_send (1 of 2 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="../async_send.html" title="basic_stream_socket::async_send">
   9 <link rel="prev" href="../async_send.html" title="basic_stream_socket::async_send">
  10 <link rel="next" href="overload2.html" title="basic_stream_socket::async_send (2 of 2 overloads)">
  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="../async_send.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_send.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="overload2.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.async_send.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::async_send (1 of 2 overloads)">basic_stream_socket::async_send
  28           (1 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Start an asynchronous send.
  32           </p>
  33 <pre class="programlisting">template&lt;
  34     typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
  35     typename <a class="link" href="../../WriteHandler.html" title="Write handler requirements">WriteHandler</a> = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
  36 <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_send(
  37     const ConstBufferSequence &amp; buffers,
  38     WriteHandler &amp;&amp; handler = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
  39 </pre>
  40 <p>
  41             This function is used to asynchronously send data on the stream socket.
  42             The function call always returns immediately.
  43           </p>
  44 <h6>
  45 <a name="boost_asio.reference.basic_stream_socket.async_send.overload1.h0"></a>
  46             <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_send.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.async_send.overload1.parameters">Parameters</a>
  47           </h6>
  48 <div class="variablelist">
  49 <p class="title"><b></b></p>
  50 <dl class="variablelist">
  51 <dt><span class="term">buffers</span></dt>
  52 <dd><p>
  53                   One or more data buffers to be sent on the socket. Although the
  54                   buffers object may be copied as necessary, ownership of the underlying
  55                   memory blocks is retained by the caller, which must guarantee that
  56                   they remain valid until the handler is called.
  57                 </p></dd>
  58 <dt><span class="term">handler</span></dt>
  59 <dd>
  60 <p>
  61                   The handler to be called when the send operation completes. Copies
  62                   will be made of the handler as required. The function signature
  63                   of the handler must be:
  64 </p>
  65 <pre class="programlisting">void handler(
  66   const boost::system::error_code&amp; error, // Result of operation.
  67   std::size_t bytes_transferred           // Number of bytes sent.
  68 );
  69 </pre>
  70 <p>
  71                   Regardless of whether the asynchronous operation completes immediately
  72                   or not, the handler will not be invoked from within this function.
  73                   On immediate completion, invocation of the handler will be performed
  74                   in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
  75                 </p>
  76 </dd>
  77 </dl>
  78 </div>
  79 <h6>
  80 <a name="boost_asio.reference.basic_stream_socket.async_send.overload1.h1"></a>
  81             <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_send.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.async_send.overload1.remarks">Remarks</a>
  82           </h6>
  83 <p>
  84             The send operation may not transmit all of the data to the peer. Consider
  85             using the <a class="link" href="../../async_write.html" title="async_write"><code class="computeroutput">async_write</code></a>
  86             function if you need to ensure that all data is written before the asynchronous
  87             operation completes.
  88           </p>
  89 <h6>
  90 <a name="boost_asio.reference.basic_stream_socket.async_send.overload1.h2"></a>
  91             <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_send.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.async_send.overload1.example">Example</a>
  92           </h6>
  93 <p>
  94             To send a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
  95             function as follows:
  96           </p>
  97 <pre class="programlisting">socket.async_send(boost::asio::buffer(data, size), handler);
  98 </pre>
  99 <p>
 100             See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
 101             documentation for information on sending multiple buffers in one go,
 102             and how to use it with arrays, boost::array or std::vector.
 103           </p>
 104 </div>
 105 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 106 <td align="left"></td>
 107 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 108         Distributed under the Boost Software License, Version 1.0. (See accompanying
 109         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>)
 110       </p>
 111 </div></td>
 112 </tr></table>
 113 <hr>
 114 <div class="spirit-nav">
 115 <a accesskey="p" href="../async_send.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_send.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 116 </div>
 117 </body>
 118 </html>