doc/html/boost_asio/reference/basic_datagram_socket/async_send_to/overload1.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 (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_to.html" title="basic_datagram_socket::async_send_to">
   9 <link rel="prev" href="../async_send_to.html" title="basic_datagram_socket::async_send_to">
  10 <link rel="next" href="overload2.html" title="basic_datagram_socket::async_send_to (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_to.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="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_datagram_socket.async_send_to.overload1"></a><a class="link" href="overload1.html" title="basic_datagram_socket::async_send_to (1 of 2 overloads)">basic_datagram_socket::async_send_to
  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_to(
  37     const ConstBufferSequence &amp; buffers,
  38     const endpoint_type &amp; destination,
  39     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>);
  40 </pre>
  41 <p>
  42             This function is used to asynchronously send a datagram to the specified
  43             remote endpoint. The function call always returns immediately.
  44           </p>
  45 <h6>
  46 <a name="boost_asio.reference.basic_datagram_socket.async_send_to.overload1.h0"></a>
  47             <span class="phrase"><a name="boost_asio.reference.basic_datagram_socket.async_send_to.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_datagram_socket.async_send_to.overload1.parameters">Parameters</a>
  48           </h6>
  49 <div class="variablelist">
  50 <p class="title"><b></b></p>
  51 <dl class="variablelist">
  52 <dt><span class="term">buffers</span></dt>
  53 <dd><p>
  54                   One or more data buffers to be sent to the remote endpoint. Although
  55                   the buffers object may be copied as necessary, ownership of the
  56                   underlying memory blocks is retained by the caller, which must
  57                   guarantee that they remain valid until the handler is called.
  58                 </p></dd>
  59 <dt><span class="term">destination</span></dt>
  60 <dd><p>
  61                   The remote endpoint to which the data will be sent. Copies will
  62                   be made of the endpoint as required.
  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
  69                   of 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_datagram_socket.async_send_to.overload1.h1"></a>
  87             <span class="phrase"><a name="boost_asio.reference.basic_datagram_socket.async_send_to.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_datagram_socket.async_send_to.overload1.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">boost::asio::ip::udp::endpoint destination(
  94     boost::asio::ip::address::from_string("1.2.3.4"), 12345);
  95 socket.async_send_to(
  96     boost::asio::buffer(data, size), destination, handler);
  97 </pre>
  98 <p>
  99             See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
 100             documentation for information on sending multiple buffers in one go,
 101             and how to use it with arrays, boost::array or std::vector.
 102           </p>
 103 </div>
 104 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 105 <td align="left"></td>
 106 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 107         Distributed under the Boost Software License, Version 1.0. (See accompanying
 108         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>)
 109       </p>
 110 </div></td>
 111 </tr></table>
 112 <hr>
 113 <div class="spirit-nav">
 114 <a accesskey="p" href="../async_send_to.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 115 </div>
 116 </body>
 117 </html>