Welcome to little lamb

Code » limb » release » tree

[release] / src / doc / allreadwrite.h / allreadwrite.h.0.md 

 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
% limb manual
% allreadwrite.h(0)
% limb 0.1.0
% 2023-07-24

# NAME

allreadwrite.h - safe I/O interface


# SYNOPSIS

    #include <limb/allreadwrite.h>


# DESCRIPTION

The header defines the needed functions to perform safe I/O operations.

<inc skalibs.md>

! INFO: Low-level API
! Note that you probably don't want/need to use the functions below, and should
! probably use a higher-level interface such as [buffer.h](0).

## Functions

The following functions/macros are defined :

: [allread](3)
:: Read from given file descriptor until requested length as been reached.

: [allreadv](3)
:: Similar to [allread](3) but using vectors.

: [allwrite](3)
:: Write to given file descriptor until requested length as been reached.

: [allwritev](3)
:: Similar to [allwrite](3) but using vectors.


: [allreadwrite](3)
:: Perform specified I/O operation until requested length as been reached.

: [allreadwritev](3)
:: Similar to [allreadwrite](3) but using vectors.


: [fd_read](3)
:: Safe wrapper around [read](3), i.e. can't be interrupted by signals.

: [fd_readv](3)
:: Safe wrapper around [readv](3), i.e. can't be interrupted by signals.

: [fd_write](3)
:: Safe wrapper around [write](3), i.e. can't be interrupted by signals.

: [fd_writev](3)
:: Safe wrapper around [writev](3), i.e. can't be interrupted by signals.


: [sanitize_read](3)
:: Sanitize return code from functions such as [read](3).

: [unsanitize_read](3)
:: Reverse the operation performed by [sanitize_read](3).