doc/html/boost_asio/reference/basic_seq_packet_socket/async_send.html

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