doc/html/boost_asio/reference/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.78.1">
   7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../ssl__stream.html" title="ssl::stream">
   9 <link rel="prev" href="async_shutdown.html" title="ssl::stream::async_shutdown">
  10 <link rel="next" href="get_io_service.html" title="ssl::stream::get_io_service">
  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="../ssl__stream.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="get_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.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 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp196675792"></a>
  31 Start an asynchronous write.
  32         </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">,</span>
  35     <span class="keyword">typename</span> <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a><span class="special">&gt;</span>
  36 <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_write_some</span><span class="special">(</span>
  37     <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  38     <span class="identifier">WriteHandler</span> <span class="identifier">handler</span><span class="special">);</span>
  39 </pre>
  40 <p>
  41           This function is used to asynchronously write one or more bytes of data
  42           to the stream. The function call always returns immediately.
  43         </p>
  44 <h6>
  45 <a name="boost_asio.reference.ssl__stream.async_write_some.h0"></a>
  46           <span class="phrase"><a name="boost_asio.reference.ssl__stream.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.ssl__stream.async_write_some.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                 The data to be written to the stream. Although the buffers object
  54                 may be copied as necessary, ownership of the underlying buffers is
  55                 retained by the caller, which must guarantee that they remain valid
  56                 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 write operation completes. Copies
  62                 will be made of the handler as required. The equivalent function
  63                 signature of the handler must be:
  64 </p>
  65 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  66   <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>
  67   <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>
  68 <span class="special">);</span>
  69 </pre>
  70 <p>
  71               </p>
  72 </dd>
  73 </dl>
  74 </div>
  75 <h6>
  76 <a name="boost_asio.reference.ssl__stream.async_write_some.h1"></a>
  77           <span class="phrase"><a name="boost_asio.reference.ssl__stream.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.ssl__stream.async_write_some.remarks">Remarks</a>
  78         </h6>
  79 <p>
  80           The async_write_some operation may not transmit all of the data to the
  81           peer. Consider using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput"><span class="identifier">async_write</span></code></a> function if you need
  82           to ensure that all data is written before the blocking operation completes.
  83         </p>
  84 </div>
  85 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  86 <td align="left"></td>
  87 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  88         Distributed under the Boost Software License, Version 1.0. (See accompanying
  89         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>)
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="async_shutdown.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.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="get_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>