File: SyncWriteStream.qbk

package info (click to toggle)
boost1.35 1.35.0-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 203,856 kB
  • ctags: 337,867
  • sloc: cpp: 938,683; xml: 56,847; ansic: 41,589; python: 18,999; sh: 11,566; makefile: 664; perl: 494; yacc: 456; asm: 353; csh: 6
file content (47 lines) | stat: -rw-r--r-- 1,574 bytes parent folder | download
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
[/
 / Copyright (c) 2003-2008 Christopher M. Kohlhoff (chris at kohlhoff dot com)
 /
 / Distributed under the Boost Software License, Version 1.0. (See accompanying
 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 /]

[section:SyncWriteStream Buffer-oriented synchronous write stream requirements]

In the table below, `a` denotes a synchronous write stream object, `cb` denotes
an object satisfying [link boost_asio.reference.ConstBufferSequence constant
buffer sequence] requirements, and `ec` denotes an object of type `error_code`.

[table Buffer-oriented synchronous write stream requirements
  [[operation] [type] [semantics, pre/post-conditions]]
  [
    [`a.write_some(cb);`]
    [`size_t`]
    [Equivalent to:
     ``
       error_code ec;
       size_t s = a.write_some(cb, ec);
       if (ec) throw system_error(ec);
       return s;
     ``]
  ]
  [
    [`a.write_some(cb, ec);`]
    [`size_t`]
    [
      Writes one or more bytes of data to the stream `a`.\n
      \n
      The constant buffer sequence `cb` specifies memory where the data to be
      written is located. The `write_some` operation shall always write a
      buffer in the sequence completely before proceeding to the next.\n
      \n
      If successful, returns the number of bytes written and sets `ec` such
      that `!ec` is true. If an error occurred, returns `0` and sets `ec` such
      that `!!ec` is true.\n
      \n
      If the total size of all buffers in the sequence `cb` is `0`, the
      function shall return `0` immediately.
    ]
  ]
]

[endsect]