Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/SyncWriteStream.html

106 lines
6.7 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Buffer-oriented synchronous write stream requirements</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">
<link rel="next" href="TimeTraits.html" title="Time traits requirements">
<meta name="viewport" content="width=device-width, initial-scale=1">
</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="SyncReadStream.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="TimeTraits.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.SyncWriteStream"></a><a class="link" href="SyncWriteStream.html" title="Buffer-oriented synchronous write stream requirements">Buffer-oriented synchronous
write stream requirements</a>
</h3></div></div></div>
<p>
A type <code class="computeroutput"><span class="identifier">X</span></code> meets the <code class="computeroutput"><span class="identifier">SyncWriteStream</span></code> requirements if it satisfies
the requirements listed below.
</p>
<p>
In the table below, <code class="computeroutput"><span class="identifier">a</span></code> denotes
a value of type <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">cb</span></code> denotes a (possibly const) value satisfying
the <a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements"><code class="computeroutput"><span class="identifier">ConstBufferSequence</span></code></a>
requirements, and <code class="computeroutput"><span class="identifier">ec</span></code> denotes
an object of type <code class="computeroutput"><span class="identifier">error_code</span></code>.
</p>
<div class="table">
<a name="asio.reference.SyncWriteStream.t0"></a><p class="title"><b>Table 33. SyncWriteStream requirements</b></p>
<div class="table-contents"><table class="table" summary="SyncWriteStream requirements">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
operation
</p>
</th>
<th>
<p>
type
</p>
</th>
<th>
<p>
semantics, pre/post-conditions
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">write_some</span><span class="special">(</span><span class="identifier">cb</span><span class="special">)</span></code><br>
<code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">write_some</span><span class="special">(</span><span class="identifier">cb</span><span class="special">,</span><span class="identifier">ec</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">size_t</span></code>
</p>
</td>
<td>
<p>
Meets the requirements for a <a class="link" href="read_write_operations.html" title="Requirements on read and write operations">write
operation</a>.<br> <br> If <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">cb</span><span class="special">)</span> <span class="special">&gt;</span>
<span class="number">0</span></code>, writes one or more bytes
of data to the stream <code class="computeroutput"><span class="identifier">a</span></code>
from the buffer sequence <code class="computeroutput"><span class="identifier">cb</span></code>.
If successful, sets <code class="computeroutput"><span class="identifier">ec</span></code>
such that <code class="computeroutput"><span class="special">!</span><span class="identifier">ec</span></code>
is <code class="computeroutput"><span class="keyword">true</span></code>, and returns
the number of bytes written. If an error occurred, sets <code class="computeroutput"><span class="identifier">ec</span></code> such that <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>,
and returns 0.<br> <br> If <code class="computeroutput"><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">cb</span><span class="special">)</span> <span class="special">==</span> <span class="number">0</span></code>, the operation shall not block.
Sets <code class="computeroutput"><span class="identifier">ec</span></code> such that
<code class="computeroutput"><span class="special">!</span><span class="identifier">ec</span></code>
is <code class="computeroutput"><span class="keyword">true</span></code>, and returns
0.
</p>
</td>
</tr></tbody>
</table></div>
</div>
<br class="table-break">
</div>
<div class="copyright-footer">Copyright © 2003-2023 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>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="SyncReadStream.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="TimeTraits.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>