doc/html/boost_asio/reference/write/overload5.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>write (5 of 8 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../write.html" title="write">
   9 <link rel="prev" href="overload4.html" title="write (4 of 8 overloads)">
  10 <link rel="next" href="overload6.html" title="write (6 of 8 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="overload4.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write.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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.write.overload5"></a><a class="link" href="overload5.html" title="write (5 of 8 overloads)">write (5 of 8
  28         overloads)</a>
  29 </h4></div></div></div>
  30 <p>
  31           Write all of the supplied data to a stream before returning.
  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="../SyncWriteStream.html" title="Buffer-oriented synchronous write stream requirements">SyncWriteStream</a><span class="special">,</span>
  35     <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">&gt;</span>
  36 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">write</span><span class="special">(</span>
  37     <span class="identifier">SyncWriteStream</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">,</span>
  38     <span class="identifier">basic_streambuf</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
  39 </pre>
  40 <p>
  41           This function is used to write a certain number of bytes of data to a stream.
  42           The call will block until one of the following conditions is true:
  43         </p>
  44 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  45 <li class="listitem">
  46               All of the data in the supplied <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a> has been written.
  47             </li>
  48 <li class="listitem">
  49               An error occurred.
  50             </li>
  51 </ul></div>
  52 <p>
  53           This operation is implemented in terms of zero or more calls to the stream's
  54           write_some function.
  55         </p>
  56 <h6>
  57 <a name="boost_asio.reference.write.overload5.h0"></a>
  58           <span class="phrase"><a name="boost_asio.reference.write.overload5.parameters"></a></span><a class="link" href="overload5.html#boost_asio.reference.write.overload5.parameters">Parameters</a>
  59         </h6>
  60 <div class="variablelist">
  61 <p class="title"><b></b></p>
  62 <dl class="variablelist">
  63 <dt><span class="term">s</span></dt>
  64 <dd><p>
  65                 The stream to which the data is to be written. The type must support
  66                 the SyncWriteStream concept.
  67               </p></dd>
  68 <dt><span class="term">b</span></dt>
  69 <dd><p>
  70                 The <a class="link" href="../basic_streambuf.html" title="basic_streambuf"><code class="computeroutput"><span class="identifier">basic_streambuf</span></code></a> object from
  71                 which data will be written.
  72               </p></dd>
  73 </dl>
  74 </div>
  75 <h6>
  76 <a name="boost_asio.reference.write.overload5.h1"></a>
  77           <span class="phrase"><a name="boost_asio.reference.write.overload5.return_value"></a></span><a class="link" href="overload5.html#boost_asio.reference.write.overload5.return_value">Return
  78           Value</a>
  79         </h6>
  80 <p>
  81           The number of bytes transferred.
  82         </p>
  83 <h6>
  84 <a name="boost_asio.reference.write.overload5.h2"></a>
  85           <span class="phrase"><a name="boost_asio.reference.write.overload5.exceptions"></a></span><a class="link" href="overload5.html#boost_asio.reference.write.overload5.exceptions">Exceptions</a>
  86         </h6>
  87 <div class="variablelist">
  88 <p class="title"><b></b></p>
  89 <dl class="variablelist">
  90 <dt><span class="term">boost::system::system_error</span></dt>
  91 <dd><p>
  92                 Thrown on failure.
  93               </p></dd>
  94 </dl>
  95 </div>
  96 <h6>
  97 <a name="boost_asio.reference.write.overload5.h3"></a>
  98           <span class="phrase"><a name="boost_asio.reference.write.overload5.remarks"></a></span><a class="link" href="overload5.html#boost_asio.reference.write.overload5.remarks">Remarks</a>
  99         </h6>
 100 <p>
 101           This overload is equivalent to calling:
 102         </p>
 103 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">write</span><span class="special">(</span>
 104     <span class="identifier">s</span><span class="special">,</span> <span class="identifier">b</span><span class="special">,</span>
 105     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">transfer_all</span><span class="special">());</span>
 106 </pre>
 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 &#169; 2003-2014 Christopher M. Kohlhoff<p>
 111         Distributed under the Boost Software License, Version 1.0. (See accompanying
 112         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>)
 113       </p>
 114 </div></td>
 115 </tr></table>
 116 <hr>
 117 <div class="spirit-nav">
 118 <a accesskey="p" href="overload4.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write.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="overload6.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 119 </div>
 120 </body>
 121 </html>