doc/html/boost_asio/reference/basic_datagram_socket/async_send_to/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_datagram_socket::async_send_to (2 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_to.html" title="basic_datagram_socket::async_send_to">
   9 <link rel="prev" href="overload1.html" title="basic_datagram_socket::async_send_to (1 of 2 overloads)">
  10 <link rel="next" href="../async_wait.html" title="basic_datagram_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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_send_to.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><h5 class="title">
  27 <a name="boost_asio.reference.basic_datagram_socket.async_send_to.overload2"></a><a class="link" href="overload2.html" title="basic_datagram_socket::async_send_to (2 of 2 overloads)">basic_datagram_socket::async_send_to
  28           (2 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_to(
  37     const ConstBufferSequence &amp; buffers,
  38     const endpoint_type &amp; destination,
  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 a datagram to the specified
  44             remote endpoint. The function call always returns immediately.
  45           </p>
  46 <h6>
  47 <a name="boost_asio.reference.basic_datagram_socket.async_send_to.overload2.h0"></a>
  48             <span class="phrase"><a name="boost_asio.reference.basic_datagram_socket.async_send_to.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_datagram_socket.async_send_to.overload2.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 to the remote endpoint. Although
  56                   the buffers object may be copied as necessary, ownership of the
  57                   underlying memory blocks is retained by the caller, which must
  58                   guarantee that they 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">destination</span></dt>
  65 <dd><p>
  66                   The remote endpoint to which the data will be sent. Copies will
  67                   be made of the endpoint as required.
  68                 </p></dd>
  69 <dt><span class="term">handler</span></dt>
  70 <dd>
  71 <p>
  72                   The handler to be called when the send operation completes. Copies
  73                   will be made of the handler as required. The function signature
  74                   of the handler must be:
  75 </p>
  76 <pre class="programlisting">void handler(
  77   const boost::system::error_code&amp; error, // Result of operation.
  78   std::size_t bytes_transferred           // Number of bytes sent.
  79 );
  80 </pre>
  81 <p>
  82                   Regardless of whether the asynchronous operation completes immediately
  83                   or not, the handler will not be invoked from within this function.
  84                   On immediate completion, invocation of the handler will be performed
  85                   in a manner equivalent to using <a class="link" href="../../post.html" title="post"><code class="computeroutput">post</code></a>.
  86                 </p>
  87 </dd>
  88 </dl>
  89 </div>
  90 </div>
  91 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  92 <td align="left"></td>
  93 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
  94         Distributed under the Boost Software License, Version 1.0. (See accompanying
  95         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>)
  96       </p>
  97 </div></td>
  98 </tr></table>
  99 <hr>
 100 <div class="spirit-nav">
 101 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_send_to.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>
 102 </div>
 103 </body>
 104 </html>