1BIO_read(3)                         OpenSSL                        BIO_read(3)
2
3
4

NAME

6       BIO_read, BIO_write, BIO_gets, BIO_puts - BIO I/O functions
7

SYNOPSIS

9        #include <openssl/bio.h>
10
11        int    BIO_read(BIO *b, void *buf, int len);
12        int    BIO_gets(BIO *b, char *buf, int size);
13        int    BIO_write(BIO *b, const void *buf, int len);
14        int    BIO_puts(BIO *b, const char *buf);
15

DESCRIPTION

17       BIO_read() attempts to read len bytes from BIO b and places the data in
18       buf.
19
20       BIO_gets() performs the BIOs "gets" operation and places the data in
21       buf. Usually this operation will attempt to read a line of data from
22       the BIO of maximum length len. There are exceptions to this however,
23       for example BIO_gets() on a digest BIO will calculate and return the
24       digest and other BIOs may not support BIO_gets() at all.
25
26       BIO_write() attempts to write len bytes from buf to BIO b.
27
28       BIO_puts() attempts to write a null terminated string buf to BIO b.
29

RETURN VALUES

31       All these functions return either the amount of data successfully read
32       or written (if the return value is positive) or that no data was
33       successfully read or written if the result is 0 or -1. If the return
34       value is -2 then the operation is not implemented in the specific BIO
35       type.
36

NOTES

38       A 0 or -1 return is not necessarily an indication of an error. In
39       particular when the source/sink is non-blocking or of a certain type it
40       may merely be an indication that no data is currently available and
41       that the application should retry the operation later.
42
43       One technique sometimes used with blocking sockets is to use a system
44       call (such as select(), poll() or equivalent) to determine when data is
45       available and then call read() to read the data. The equivalent with
46       BIOs (that is call select() on the underlying I/O structure and then
47       call BIO_read() to read the data) should not be used because a single
48       call to BIO_read() can cause several reads (and writes in the case of
49       SSL BIOs) on the underlying I/O structure and may block as a result.
50       Instead select() (or equivalent) should be combined with non blocking
51       I/O so successive reads will request a retry instead of blocking.
52
53       See BIO_should_retry(3) for details of how to determine the cause of a
54       retry and other I/O issues.
55
56       If the BIO_gets() function is not supported by a BIO then it possible
57       to work around this by adding a buffering BIO BIO_f_buffer(3) to the
58       chain.
59

SEE ALSO

61       BIO_should_retry(3)
62
63       TBA
64
65
66
671.0.2o                            2020-01-28                       BIO_read(3)
Impressum