• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_stream_socket::send (2 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.html" title="basic_stream_socket::send">
9<link rel="prev" href="overload1.html" title="basic_stream_socket::send (1 of 3 overloads)">
10<link rel="next" href="overload3.html" title="basic_stream_socket::send (3 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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../send.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="overload3.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_stream_socket.send.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::send (2 of 3 overloads)">basic_stream_socket::send
28          (2 of 3 overloads)</a>
29</h5></div></div></div>
30<p>
31            Send some data on the socket.
32          </p>
33<pre class="programlisting">template&lt;
34    typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
35std::size_t send(
36    const ConstBufferSequence &amp; buffers,
37    socket_base::message_flags flags);
38</pre>
39<p>
40            This function is used to send data on the stream socket. The function
41            call will block until one or more bytes of the data has been sent successfully,
42            or an until error occurs.
43          </p>
44<h6>
45<a name="boost_asio.reference.basic_stream_socket.send.overload2.h0"></a>
46            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.send.overload2.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 on the socket.
54                </p></dd>
55<dt><span class="term">flags</span></dt>
56<dd><p>
57                  Flags specifying how the send call is to be made.
58                </p></dd>
59</dl>
60</div>
61<h6>
62<a name="boost_asio.reference.basic_stream_socket.send.overload2.h1"></a>
63            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.send.overload2.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_stream_socket.send.overload2.h2"></a>
71            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.send.overload2.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_stream_socket.send.overload2.h3"></a>
84            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.send.overload2.remarks">Remarks</a>
85          </h6>
86<p>
87            The send operation may not transmit all of the data to the peer. Consider
88            using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
89            function if you need to ensure that all data is written before the blocking
90            operation completes.
91          </p>
92<h6>
93<a name="boost_asio.reference.basic_stream_socket.send.overload2.h4"></a>
94            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.send.overload2.example">Example</a>
95          </h6>
96<p>
97            To send a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
98            function as follows:
99          </p>
100<pre class="programlisting">socket.send(boost::asio::buffer(data, size), 0);
101</pre>
102<p>
103            See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
104            documentation for information on sending multiple buffers in one go,
105            and how to use it with arrays, boost::array or std::vector.
106          </p>
107</div>
108<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
109<td align="left"></td>
110<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
111      Kohlhoff<p>
112        Distributed under the Boost Software License, Version 1.0. (See accompanying
113        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>)
114      </p>
115</div></td>
116</tr></table>
117<hr>
118<div class="spirit-nav">
119<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../send.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
120</div>
121</body>
122</html>
123