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
|
/* Non-blocking I/O for pipe or socket descriptors.
Copyright (C) 2011-2024 Free Software Foundation, Inc.
This file is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This file is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
#ifndef _NONBLOCKING_H
#define _NONBLOCKING_H
/* Non-blocking I/O is an I/O mode by which read(), write() calls avoid
blocking the current thread. When non-blocking is enabled:
- A read() call returns -1 with errno set to EAGAIN when no data or EOF
information is immediately available.
- A write() call returns -1 with errno set to EAGAIN when it cannot
transport the requested amount of data (but at most one pipe buffer)
without blocking.
Non-blocking I/O is most useful for character devices, pipes, and sockets.
Whether it also works on regular files and block devices is platform
dependent.
There are three modern alternatives to non-blocking I/O:
- use select() or poll() followed by read() or write() if the descriptor
is ready,
- call read() or write() in separate threads,
- use <aio.h> interfaces. */
#ifdef __cplusplus
extern "C" {
#endif
/* Return 1 if I/O to the descriptor DESC is currently non-blocking, 0
it is blocking, or -1 with errno set if fd is invalid or blocking
status cannot be determined (such as with sockets on mingw). */
extern int get_nonblocking_flag (int desc);
/* Specify the non-blocking flag for the descriptor DESC.
Return 0 upon success, or -1 with errno set upon failure.
The default depends on the presence of the O_NONBLOCK flag for files
or pipes opened with open() or on the presence of the SOCK_NONBLOCK
flag for sockets. */
extern int set_nonblocking_flag (int desc, bool value);
#ifdef __cplusplus
}
#endif
#endif /* _NONBLOCKING_H */
|