Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 3ff61ef50f7b6da9fdee54352ae073f9 > files > 1116

asio-1.4.8-7.mga5.i586.rpm

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>basic_stream_socket::async_send (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="../../../../index.html" title="Asio">
<link rel="up" href="../async_send.html" title="basic_stream_socket::async_send">
<link rel="prev" href="overload1.html" title="basic_stream_socket::async_send (1 of 2 overloads)">
<link rel="next" href="../async_write_some.html" title="basic_stream_socket::async_write_some">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../async_send.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../async_write_some.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_stream_socket.async_send.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::async_send (2 of 2 overloads)">basic_stream_socket::async_send
          (2 of 2 overloads)</a>
</h5></div></div></div>
<p>
            Start an asynchronous send.
          </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">,</span>
    <span class="keyword">typename</span> <a class="link" href="../../WriteHandler.html" title="Write handler requirements">WriteHandler</a><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">async_send</span><span class="special">(</span>
    <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
    <span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">message_flags</span> <span class="identifier">flags</span><span class="special">,</span>
    <span class="identifier">WriteHandler</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
<p>
            This function is used to asynchronously send data on the stream socket.
            The function call always returns immediately.
          </p>
<a name="asio.reference.basic_stream_socket.async_send.overload2.parameters"></a><h6>
<a name="id908628"></a>
            <a class="link" href="overload2.html#asio.reference.basic_stream_socket.async_send.overload2.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
                  One or more data buffers to be sent on the socket. Although the
                  buffers object may be copied as necessary, ownership of the underlying
                  memory blocks is retained by the caller, which must guarantee that
                  they remain valid until the handler is called.
                </p></dd>
<dt><span class="term">flags</span></dt>
<dd><p>
                  Flags specifying how the send call is to be made.
                </p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
                  The handler to be called when the send operation completes. Copies
                  will be made of the handler as required. The function signature
                  of the handler must be: 
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  <span class="keyword">const</span> <span class="identifier">asio</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>  <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 sent.
</span><span class="special">);</span> 
</pre>
<p>
                  Regardless of whether the asynchronous operation completes immediately
                  or not, the handler will not be invoked from within this function.
                  Invocation of the handler will be performed in a manner equivalent
                  to using <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>.
                </p>
</dd>
</dl>
</div>
<a name="asio.reference.basic_stream_socket.async_send.overload2.remarks"></a><h6>
<a name="id908827"></a>
            <a class="link" href="overload2.html#asio.reference.basic_stream_socket.async_send.overload2.remarks">Remarks</a>
          </h6>
<p>
            The send operation may not transmit all of the data to the 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 to ensure that all data is written before the asynchronous
            operation completes.
          </p>
<a name="asio.reference.basic_stream_socket.async_send.overload2.example"></a><h6>
<a name="id908867"></a>
            <a class="link" href="overload2.html#asio.reference.basic_stream_socket.async_send.overload2.example">Example</a>
          </h6>
<p>
            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:
          </p>
<pre class="programlisting"><span class="identifier">socket</span><span class="special">.</span><span class="identifier">async_send</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="number">0</span><span class="special">,</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
<p>
            See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a>
            documentation for information on sending multiple buffers in one go,
            and how to use it with arrays, boost::array or std::vector.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003 - 2010 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../async_send.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../async_write_some.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>