doc/html/boost_asio/reference/basic_raw_socket/send_to/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_raw_socket::send_to (1 of 3 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="../send_to.html" title="basic_raw_socket::send_to">
   9 <link rel="prev" href="../send_to.html" title="basic_raw_socket::send_to">
  10 <link rel="next" href="overload2.html" title="basic_raw_socket::send_to (2 of 3 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="../send_to.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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_raw_socket.send_to.overload1"></a><a class="link" href="overload1.html" title="basic_raw_socket::send_to (1 of 3 overloads)">basic_raw_socket::send_to
  28           (1 of 3 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Send raw data to the specified endpoint.
  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">&gt;</span>
  35 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">send_to</span><span class="special">(</span>
  36     <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
  37     <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&amp;</span> <span class="identifier">destination</span><span class="special">);</span>
  38 </pre>
  39 <p>
  40             This function is used to send raw data to the specified remote endpoint.
  41             The function call will block until the data has been sent successfully
  42             or an error occurs.
  43           </p>
  44 <h6>
  45 <a name="boost_asio.reference.basic_raw_socket.send_to.overload1.h0"></a>
  46             <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.send_to.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.send_to.overload1.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                   One or more data buffers to be sent to the remote endpoint.
  54                 </p></dd>
  55 <dt><span class="term">destination</span></dt>
  56 <dd><p>
  57                   The remote endpoint to which the data will be sent.
  58                 </p></dd>
  59 </dl>
  60 </div>
  61 <h6>
  62 <a name="boost_asio.reference.basic_raw_socket.send_to.overload1.h1"></a>
  63             <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.send_to.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.send_to.overload1.return_value">Return
  64             Value</a>
  65           </h6>
  66 <p>
  67             The number of bytes sent.
  68           </p>
  69 <h6>
  70 <a name="boost_asio.reference.basic_raw_socket.send_to.overload1.h2"></a>
  71             <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.send_to.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.send_to.overload1.exceptions">Exceptions</a>
  72           </h6>
  73 <div class="variablelist">
  74 <p class="title"><b></b></p>
  75 <dl class="variablelist">
  76 <dt><span class="term">boost::system::system_error</span></dt>
  77 <dd><p>
  78                   Thrown on failure.
  79                 </p></dd>
  80 </dl>
  81 </div>
  82 <h6>
  83 <a name="boost_asio.reference.basic_raw_socket.send_to.overload1.h3"></a>
  84             <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.send_to.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_raw_socket.send_to.overload1.example">Example</a>
  85           </h6>
  86 <p>
  87             To send a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows:
  88           </p>
  89 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">udp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">destination</span><span class="special">(</span>
  90     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">address</span><span class="special">::</span><span class="identifier">from_string</span><span class="special">(</span><span class="string">"1.2.3.4"</span><span class="special">),</span> <span class="number">12345</span><span class="special">);</span>
  91 <span class="identifier">socket</span><span class="special">.</span><span class="identifier">send_to</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="identifier">destination</span><span class="special">);</span>
  92 </pre>
  93 <p>
  94             See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
  95             documentation for information on sending multiple buffers in one go,
  96             and how to use it with arrays, boost::array or std::vector.
  97           </p>
  98 </div>
  99 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 100 <td align="left"></td>
 101 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 102         Distributed under the Boost Software License, Version 1.0. (See accompanying
 103         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>)
 104       </p>
 105 </div></td>
 106 </tr></table>
 107 <hr>
 108 <div class="spirit-nav">
 109 <a accesskey="p" href="../send_to.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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>
 110 </div>
 111 </body>
 112 </html>