summaryrefslogtreecommitdiff
path: root/doc/html/boost_asio/reference/SyncWriteStream.html
blob: c22dae62ae3bd6f605351a7600a002bedb771905 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Buffer-oriented synchronous write stream requirements</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.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">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="SyncReadStream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="TimeTraits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_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">X</code> meets the <code class="computeroutput">SyncWriteStream</code> requirements
        if it satisfies the requirements listed below.
      </p>
<p>
        In the table below, <code class="computeroutput">a</code> denotes a value of type <code class="computeroutput">X</code>,
        <code class="computeroutput">cb</code> denotes a (possibly const) value satisfying the <a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements"><code class="computeroutput">ConstBufferSequence</code></a>
        requirements, and <code class="computeroutput">ec</code> denotes an object of type <code class="computeroutput">error_code</code>.
      </p>
<div class="table">
<a name="boost_asio.reference.SyncWriteStream.t0"></a><p class="title"><b>Table&#160;30.&#160;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">a.write_some(cb)</code><br> <code class="computeroutput">a.write_some(cb,ec)</code>
                </p>
              </td>
<td>
                <p>
                  <code class="computeroutput">size_t</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">buffer_size(cb) &gt; 0</code>,
                  writes one or more bytes of data to the stream <code class="computeroutput">a</code> from
                  the buffer sequence <code class="computeroutput">cb</code>. If successful, sets <code class="computeroutput">ec</code>
                  such that <code class="computeroutput">!ec</code> is <code class="computeroutput">true</code>, and returns the
                  number of bytes written. If an error occurred, sets <code class="computeroutput">ec</code>
                  such that <code class="computeroutput">!!ec</code> is <code class="computeroutput">true</code>, and returns 0.<br>
                  <br> If <code class="computeroutput">buffer_size(cb) == 0</code>, the operation shall
                  not block. Sets <code class="computeroutput">ec</code> such that <code class="computeroutput">!ec</code> is
                  <code class="computeroutput">true</code>, and returns 0.
                </p>
              </td>
</tr></tbody>
</table></div>
</div>
<br class="table-break">
</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-2019 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="SyncReadStream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="TimeTraits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>