secure/lib/libcrypto/man/man3/BIO_read.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BIO_READ 3"
 136 .TH BIO_READ 3 "2020-03-17" "1.1.1e" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BIO_read_ex, BIO_write_ex, BIO_read, BIO_write, BIO_gets, BIO_puts \&\- BIO I/O functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bio.h>
 147 \&
 148 \& int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
 149 \& int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
 150 \&
 151 \& int BIO_read(BIO *b, void *data, int dlen);
 152 \& int BIO_gets(BIO *b, char *buf, int size);
 153 \& int BIO_write(BIO *b, const void *data, int dlen);
 154 \& int BIO_puts(BIO *b, const char *buf);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fBBIO_read_ex()\fR attempts to read \fBdlen\fR bytes from \s-1BIO\s0 \fBb\fR and places the data
 159 in \fBdata\fR. If any bytes were successfully read then the number of bytes read is
 160 stored in \fB*readbytes\fR.
 161 .PP
 162 \&\fBBIO_write_ex()\fR attempts to write \fBdlen\fR bytes from \fBdata\fR to \s-1BIO\s0 \fBb\fR. If
 163 successful then the number of bytes written is stored in \fB*written\fR.
 164 .PP
 165 \&\fBBIO_read()\fR attempts to read \fBlen\fR bytes from \s-1BIO\s0 \fBb\fR and places
 166 the data in \fBbuf\fR.
 167 .PP
 168 \&\fBBIO_gets()\fR performs the BIOs \*(L"gets\*(R" operation and places the data
 169 in \fBbuf\fR. Usually this operation will attempt to read a line of data
 170 from the \s-1BIO\s0 of maximum length \fBsize\-1\fR. There are exceptions to this,
 171 however; for example, \fBBIO_gets()\fR on a digest \s-1BIO\s0 will calculate and
 172 return the digest and other BIOs may not support \fBBIO_gets()\fR at all.
 173 The returned string is always NUL-terminated and the '\en' is preserved
 174 if present in the input data.
 175 .PP
 176 \&\fBBIO_write()\fR attempts to write \fBlen\fR bytes from \fBbuf\fR to \s-1BIO\s0 \fBb\fR.
 177 .PP
 178 \&\fBBIO_puts()\fR attempts to write a NUL-terminated string \fBbuf\fR to \s-1BIO\s0 \fBb\fR.
 179 .SH "RETURN VALUES"
 180 .IX Header "RETURN VALUES"
 181 \&\fBBIO_read_ex()\fR and \fBBIO_write_ex()\fR return 1 if data was successfully read or
 182 written, and 0 otherwise.
 183 .PP
 184 All other functions return either the amount of data successfully read or
 185 written (if the return value is positive) or that no data was successfully
 186 read or written if the result is 0 or \-1. If the return value is \-2 then
 187 the operation is not implemented in the specific \s-1BIO\s0 type.  The trailing
 188 \&\s-1NUL\s0 is not included in the length returned by \fBBIO_gets()\fR.
 189 .SH "NOTES"
 190 .IX Header "NOTES"
 191 A 0 or \-1 return is not necessarily an indication of an error. In
 192 particular when the source/sink is non-blocking or of a certain type
 193 it may merely be an indication that no data is currently available and that
 194 the application should retry the operation later.
 195 .PP
 196 One technique sometimes used with blocking sockets is to use a system call
 197 (such as \fBselect()\fR, \fBpoll()\fR or equivalent) to determine when data is available
 198 and then call \fBread()\fR to read the data. The equivalent with BIOs (that is call
 199 \&\fBselect()\fR on the underlying I/O structure and then call \fBBIO_read()\fR to
 200 read the data) should \fBnot\fR be used because a single call to \fBBIO_read()\fR
 201 can cause several reads (and writes in the case of \s-1SSL\s0 BIOs) on the underlying
 202 I/O structure and may block as a result. Instead \fBselect()\fR (or equivalent)
 203 should be combined with non blocking I/O so successive reads will request
 204 a retry instead of blocking.
 205 .PP
 206 See \fBBIO_should_retry\fR\|(3) for details of how to
 207 determine the cause of a retry and other I/O issues.
 208 .PP
 209 If the \fBBIO_gets()\fR function is not supported by a \s-1BIO\s0 then it possible to
 210 work around this by adding a buffering \s-1BIO\s0 \fBBIO_f_buffer\fR\|(3)
 211 to the chain.
 212 .SH "SEE ALSO"
 213 .IX Header "SEE ALSO"
 214 \&\fBBIO_should_retry\fR\|(3)
 215 .SH "HISTORY"
 216 .IX Header "HISTORY"
 217 \&\fBBIO_gets()\fR on 1.1.0 and older when called on \fBBIO_fd()\fR based \s-1BIO\s0 does not
 218 keep the '\en' at the end of the line in the buffer.
 219 .SH "COPYRIGHT"
 220 .IX Header "COPYRIGHT"
 221 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 222 .PP
 223 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 224 this file except in compliance with the License.  You can obtain a copy
 225 in the file \s-1LICENSE\s0 in the source distribution or at
 226 <https://www.openssl.org/source/license.html>.