libs/beast/doc/html/beast/ref/boost__beast__ssl_stream/async_write_some.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ssl_stream::async_write_some</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="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__ssl_stream.html" title="ssl_stream">
   9 <link rel="prev" href="async_shutdown.html" title="ssl_stream::async_shutdown">
  10 <link rel="next" href="executor_type.html" title="ssl_stream::executor_type">
  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_shutdown.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="executor_type.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="beast.ref.boost__beast__ssl_stream.async_write_some"></a><a class="link" href="async_write_some.html" title="ssl_stream::async_write_some">ssl_stream::async_write_some</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873484184976"></a>
  31 Start an asynchronous write.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__ssl_stream.async_write_some.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_write_some.synopsis"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__ssl_stream.async_write_some.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  38     <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/ConstBufferSequence.html" target="_top"><span class="emphasis"><em>ConstBufferSequence</em></span></a><span class="special">,</span>
  39     <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/WriteHandler.html" target="_top"><span class="emphasis"><em>WriteHandler</em></span></a><span class="special">&gt;</span>
  40 <a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
  41 <span class="identifier">async_write_some</span><span class="special">(</span>
  42     <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  43     <span class="identifier">BOOST_ASIO_MOVE_ARG</span><span class="special">(</span><span class="identifier">WriteHandler</span><span class="special">)</span> <span class="identifier">handler</span><span class="special">);</span>
  44 </pre>
  45 <h6>
  46 <a name="beast.ref.boost__beast__ssl_stream.async_write_some.h1"></a>
  47           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_write_some.description"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__ssl_stream.async_write_some.description">Description</a>
  48         </h6>
  49 <p>
  50           This function is used to asynchronously write one or more bytes of data
  51           to the stream. The function call always returns immediately.
  52         </p>
  53 <h6>
  54 <a name="beast.ref.boost__beast__ssl_stream.async_write_some.h2"></a>
  55           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__ssl_stream.async_write_some.parameters">Parameters</a>
  56         </h6>
  57 <div class="informaltable"><table class="table">
  58 <colgroup>
  59 <col>
  60 <col>
  61 </colgroup>
  62 <thead><tr>
  63 <th>
  64                   <p>
  65                     Name
  66                   </p>
  67                 </th>
  68 <th>
  69                   <p>
  70                     Description
  71                   </p>
  72                 </th>
  73 </tr></thead>
  74 <tbody>
  75 <tr>
  76 <td>
  77                   <p>
  78                     <code class="computeroutput"><span class="identifier">buffers</span></code>
  79                   </p>
  80                 </td>
  81 <td>
  82                   <p>
  83                     The data to be written to the stream. Although the buffers object
  84                     may be copied as necessary, ownership of the underlying buffers
  85                     is retained by the caller, which must guarantee that they remain
  86                     valid until the handler is called.
  87                   </p>
  88                 </td>
  89 </tr>
  90 <tr>
  91 <td>
  92                   <p>
  93                     <code class="computeroutput"><span class="identifier">handler</span></code>
  94                   </p>
  95                 </td>
  96 <td>
  97                   <p>
  98                     The handler to be called when the write operation completes.
  99                     Copies will be made of the handler as required. The equivalent
 100                     function signature of the handler must be:
 101                   </p>
 102 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
 103   <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span>
 104   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span>           <span class="comment">// Number of bytes written.</span>
 105 <span class="special">);</span>
 106 </pre>
 107                 </td>
 108 </tr>
 109 </tbody>
 110 </table></div>
 111 <h6>
 112 <a name="beast.ref.boost__beast__ssl_stream.async_write_some.h3"></a>
 113           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#beast.ref.boost__beast__ssl_stream.async_write_some.remarks">Remarks</a>
 114         </h6>
 115 <p>
 116           The <code class="computeroutput"><span class="identifier">async_write_some</span></code> operation
 117           may not transmit all of the data to the peer. Consider using the <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">async_write</span></code> function if you need to ensure
 118           that all data is written before the asynchronous operation completes.
 119         </p>
 120 </div>
 121 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 122 <td align="left"></td>
 123 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 124       Falco<p>
 125         Distributed under the Boost Software License, Version 1.0. (See accompanying
 126         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>)
 127       </p>
 128 </div></td>
 129 </tr></table>
 130 <hr>
 131 <div class="spirit-nav">
 132 <a accesskey="p" href="async_shutdown.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="executor_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 133 </div>
 134 </body>
 135 </html>