• 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 (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.html" title="basic_stream_socket::send">
9<link rel="prev" href="../send.html" title="basic_stream_socket::send">
10<link rel="next" href="overload2.html" title="basic_stream_socket::send (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.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="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_stream_socket.send.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::send (1 of 3 overloads)">basic_stream_socket::send
28          (1 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</pre>
38<p>
39            This function is used to send data on the stream socket. The function
40            call will block until one or more bytes of the data has been sent successfully,
41            or an until error occurs.
42          </p>
43<h6>
44<a name="boost_asio.reference.basic_stream_socket.send.overload1.h0"></a>
45            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.send.overload1.parameters">Parameters</a>
46          </h6>
47<div class="variablelist">
48<p class="title"><b></b></p>
49<dl class="variablelist">
50<dt><span class="term">buffers</span></dt>
51<dd><p>
52                  One or more data buffers to be sent on the socket.
53                </p></dd>
54</dl>
55</div>
56<h6>
57<a name="boost_asio.reference.basic_stream_socket.send.overload1.h1"></a>
58            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.send.overload1.return_value">Return
59            Value</a>
60          </h6>
61<p>
62            The number of bytes sent.
63          </p>
64<h6>
65<a name="boost_asio.reference.basic_stream_socket.send.overload1.h2"></a>
66            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.send.overload1.exceptions">Exceptions</a>
67          </h6>
68<div class="variablelist">
69<p class="title"><b></b></p>
70<dl class="variablelist">
71<dt><span class="term">boost::system::system_error</span></dt>
72<dd><p>
73                  Thrown on failure.
74                </p></dd>
75</dl>
76</div>
77<h6>
78<a name="boost_asio.reference.basic_stream_socket.send.overload1.h3"></a>
79            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.send.overload1.remarks">Remarks</a>
80          </h6>
81<p>
82            The send operation may not transmit all of the data to the peer. Consider
83            using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
84            function if you need to ensure that all data is written before the blocking
85            operation completes.
86          </p>
87<h6>
88<a name="boost_asio.reference.basic_stream_socket.send.overload1.h4"></a>
89            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.send.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.send.overload1.example">Example</a>
90          </h6>
91<p>
92            To send a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
93            function as follows:
94          </p>
95<pre class="programlisting">socket.send(boost::asio::buffer(data, size));
96</pre>
97<p>
98            See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput">buffer</code></a>
99            documentation for information on sending multiple buffers in one go,
100            and how to use it with arrays, boost::array or std::vector.
101          </p>
102</div>
103<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
104<td align="left"></td>
105<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
106      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="../send.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
115</div>
116</body>
117</html>
118