secure/lib/libcrypto/man/BIO_read.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_READ 3"
 132 .TH BIO_READ 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BIO_read_ex, BIO_write_ex, BIO_read, BIO_write, BIO_gets, BIO_puts \&\- BIO I/O functions
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
 145 \& int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
 146 \&
 147 \& int BIO_read(BIO *b, void *data, int dlen);
 148 \& int BIO_gets(BIO *b, char *buf, int size);
 149 \& int BIO_write(BIO *b, const void *data, int dlen);
 150 \& int BIO_puts(BIO *b, const char *buf);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fIBIO_read_ex()\fR attempts to read \fBdlen\fR bytes from \s-1BIO\s0 \fBb\fR and places the data
 155 in \fBdata\fR. If any bytes were successfully read then the number of bytes read is
 156 stored in \fB*readbytes\fR.
 157 .PP
 158 \&\fIBIO_write_ex()\fR attempts to write \fBdlen\fR bytes from \fBdata\fR to \s-1BIO\s0 \fBb\fR. If
 159 successful then the number of bytes written is stored in \fB*written\fR.
 160 .PP
 161 \&\fIBIO_read()\fR attempts to read \fBlen\fR bytes from \s-1BIO\s0 \fBb\fR and places
 162 the data in \fBbuf\fR.
 163 .PP
 164 \&\fIBIO_gets()\fR performs the BIOs \*(L"gets\*(R" operation and places the data
 165 in \fBbuf\fR. Usually this operation will attempt to read a line of data
 166 from the \s-1BIO\s0 of maximum length \fBsize\-1\fR. There are exceptions to this,
 167 however; for example, \fIBIO_gets()\fR on a digest \s-1BIO\s0 will calculate and
 168 return the digest and other BIOs may not support \fIBIO_gets()\fR at all.
 169 The returned string is always NUL-terminated and the '\en' is preserved
 170 if present in the input data.
 171 .PP
 172 \&\fIBIO_write()\fR attempts to write \fBlen\fR bytes from \fBbuf\fR to \s-1BIO\s0 \fBb\fR.
 173 .PP
 174 \&\fIBIO_puts()\fR attempts to write a NUL-terminated string \fBbuf\fR to \s-1BIO\s0 \fBb\fR.
 175 .SH "RETURN VALUES"
 176 .IX Header "RETURN VALUES"
 177 \&\fIBIO_read_ex()\fR and \fIBIO_write_ex()\fR return 1 if data was successfully read or
 178 written, and 0 otherwise.
 179 .PP
 180 All other functions return either the amount of data successfully read or
 181 written (if the return value is positive) or that no data was successfully
 182 read or written if the result is 0 or \-1. If the return value is \-2 then
 183 the operation is not implemented in the specific \s-1BIO\s0 type.  The trailing
 184 \&\s-1NUL\s0 is not included in the length returned by \fIBIO_gets()\fR.
 185 .SH "NOTES"
 186 .IX Header "NOTES"
 187 A 0 or \-1 return is not necessarily an indication of an error. In
 188 particular when the source/sink is non-blocking or of a certain type
 189 it may merely be an indication that no data is currently available and that
 190 the application should retry the operation later.
 191 .PP
 192 One technique sometimes used with blocking sockets is to use a system call
 193 (such as \fIselect()\fR, \fIpoll()\fR or equivalent) to determine when data is available
 194 and then call \fIread()\fR to read the data. The equivalent with BIOs (that is call
 195 \&\fIselect()\fR on the underlying I/O structure and then call \fIBIO_read()\fR to
 196 read the data) should \fBnot\fR be used because a single call to \fIBIO_read()\fR
 197 can cause several reads (and writes in the case of \s-1SSL\s0 BIOs) on the underlying
 198 I/O structure and may block as a result. Instead \fIselect()\fR (or equivalent)
 199 should be combined with non blocking I/O so successive reads will request
 200 a retry instead of blocking.
 201 .PP
 202 See \fIBIO_should_retry\fR\|(3) for details of how to
 203 determine the cause of a retry and other I/O issues.
 204 .PP
 205 If the \fIBIO_gets()\fR function is not supported by a \s-1BIO\s0 then it possible to
 206 work around this by adding a buffering \s-1BIO\s0 \fIBIO_f_buffer\fR\|(3)
 207 to the chain.
 208 .SH "SEE ALSO"
 209 .IX Header "SEE ALSO"
 210 \&\fIBIO_should_retry\fR\|(3)
 211 .SH "HISTORY"
 212 .IX Header "HISTORY"
 213 \&\fIBIO_gets()\fR on 1.1.0 and older when called on \fIBIO_fd()\fR based \s-1BIO\s0 does not
 214 keep the '\en' at the end of the line in the buffer.
 215 .SH "COPYRIGHT"
 216 .IX Header "COPYRIGHT"
 217 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 218 .PP
 219 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 220 this file except in compliance with the License.  You can obtain a copy
 221 in the file \s-1LICENSE\s0 in the source distribution or at
 222 <https://www.openssl.org/source/license.html>.