crypto/external/bsd/openssl/lib/libcrypto/man/BIO_s_mem.3

   1 .\"     $NetBSD: BIO_s_mem.3,v 1.14 2015/06/12 17:01:13 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .de Vb \" Begin verbatim text
  12 .ft CW
  13 .nf
  14 .ne \\$1
  15 ..
  16 .de Ve \" End verbatim text
  17 .ft R
  18 .fi
  19 ..
  20 .\" Set up some character translations and predefined strings.  \*(-- will
  21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  25 .\" nothing in troff, for use with C<>.
  26 .tr \(*W-
  27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  28 .ie n \{\
  29 .    ds -- \(*W-
  30 .    ds PI pi
  31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  33 .    ds L" ""
  34 .    ds R" ""
  35 .    ds C` ""
  36 .    ds C' ""
  37 'br\}
  38 .el\{\
  39 .    ds -- \|\(em\|
  40 .    ds PI \(*p
  41 .    ds L" ``
  42 .    ds R" ''
  43 .    ds C`
  44 .    ds C'
  45 'br\}
  46 .\"
  47 .\" Escape single quotes in literal strings from groff's Unicode transform.
  48 .ie \n(.g .ds Aq \(aq
  49 .el       .ds Aq '
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .\"
  56 .\" Avoid warning from groff about undefined register 'F'.
  57 .de IX
  58 ..
  59 .nr rF 0
  60 .if \n(.g .if rF .nr rF 1
  61 .if (\n(rF:(\n(.g==0)) \{
  62 .    if \nF \{
  63 .        de IX
  64 .        tm Index:\\$1\t\\n%\t"\\$2"
  65 ..
  66 .        if !\nF==2 \{
  67 .            nr % 0
  68 .            nr F 2
  69 .        \}
  70 .    \}
  71 .\}
  72 .rr rF
  73 .\"
  74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  76 .    \" fudge factors for nroff and troff
  77 .if n \{\
  78 .    ds #H 0
  79 .    ds #V .8m
  80 .    ds #F .3m
  81 .    ds #[ \f1
  82 .    ds #] \fP
  83 .\}
  84 .if t \{\
  85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  86 .    ds #V .6m
  87 .    ds #F 0
  88 .    ds #[ \&
  89 .    ds #] \&
  90 .\}
  91 .    \" simple accents for nroff and troff
  92 .if n \{\
  93 .    ds ' \&
  94 .    ds ` \&
  95 .    ds ^ \&
  96 .    ds , \&
  97 .    ds ~ ~
  98 .    ds /
  99 .\}
 100 .if t \{\
 101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 107 .\}
 108 .    \" troff and (daisy-wheel) nroff accents
 109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 116 .ds ae a\h'-(\w'a'u*4/10)'e
 117 .ds Ae A\h'-(\w'A'u*4/10)'E
 118 .    \" corrections for vroff
 119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 121 .    \" for low resolution devices (crt and lpr)
 122 .if \n(.H>23 .if \n(.V>19 \
 123 \{\
 124 .    ds : e
 125 .    ds 8 ss
 126 .    ds o a
 127 .    ds d- d\h'-1'\(ga
 128 .    ds D- D\h'-1'\(hy
 129 .    ds th \o'bp'
 130 .    ds Th \o'LP'
 131 .    ds ae ae
 132 .    ds Ae AE
 133 .\}
 134 .rm #[ #] #H #V #F C
 135 .\" ========================================================================
 136 .\"
 137 .IX Title "BIO_s_mem 3"
 138 .TH BIO_s_mem 3 "2009-07-19" "1.0.1n" "OpenSSL"
 139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 140 .\" way too many mistakes in technical documents.
 141 .if n .ad l
 142 .nh
 143 .SH "NAME"
 144 BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
 145 BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
 146 .SH "LIBRARY"
 147 libcrypto, -lcrypto
 148 .SH "SYNOPSIS"
 149 .IX Header "SYNOPSIS"
 150 .Vb 1
 151 \& #include <openssl/bio.h>
 152 \&
 153 \& BIO_METHOD *   BIO_s_mem(void);
 154 \&
 155 \& BIO_set_mem_eof_return(BIO *b,int v)
 156 \& long BIO_get_mem_data(BIO *b, char **pp)
 157 \& BIO_set_mem_buf(BIO *b,BUF_MEM *bm,int c)
 158 \& BIO_get_mem_ptr(BIO *b,BUF_MEM **pp)
 159 \&
 160 \& BIO *BIO_new_mem_buf(void *buf, int len);
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 \&\fIBIO_s_mem()\fR return the memory \s-1BIO\s0 method function.
 165 .PP
 166 A memory \s-1BIO\s0 is a source/sink \s-1BIO\s0 which uses memory for its I/O. Data
 167 written to a memory \s-1BIO\s0 is stored in a \s-1BUF_MEM\s0 structure which is extended
 168 as appropriate to accommodate the stored data.
 169 .PP
 170 Any data written to a memory \s-1BIO\s0 can be recalled by reading from it.
 171 Unless the memory \s-1BIO\s0 is read only any data read from it is deleted from
 172 the \s-1BIO.\s0
 173 .PP
 174 Memory BIOs support \fIBIO_gets()\fR and \fIBIO_puts()\fR.
 175 .PP
 176 If the \s-1BIO_CLOSE\s0 flag is set when a memory \s-1BIO\s0 is freed then the underlying
 177 \&\s-1BUF_MEM\s0 structure is also freed.
 178 .PP
 179 Calling \fIBIO_reset()\fR on a read write memory \s-1BIO\s0 clears any data in it. On a
 180 read only \s-1BIO\s0 it restores the \s-1BIO\s0 to its original state and the read only
 181 data can be read again.
 182 .PP
 183 \&\fIBIO_eof()\fR is true if no data is in the \s-1BIO.\s0
 184 .PP
 185 \&\fIBIO_ctrl_pending()\fR returns the number of bytes currently stored.
 186 .PP
 187 \&\fIBIO_set_mem_eof_return()\fR sets the behaviour of memory \s-1BIO \s0\fBb\fR when it is
 188 empty. If the \fBv\fR is zero then an empty memory \s-1BIO\s0 will return \s-1EOF \s0(that is
 189 it will return zero and BIO_should_retry(b) will be false. If \fBv\fR is non
 190 zero then it will return \fBv\fR when it is empty and it will set the read retry
 191 flag (that is BIO_read_retry(b) is true). To avoid ambiguity with a normal
 192 positive return value \fBv\fR should be set to a negative value, typically \-1.
 193 .PP
 194 \&\fIBIO_get_mem_data()\fR sets \fBpp\fR to a pointer to the start of the memory BIOs data
 195 and returns the total amount of data available. It is implemented as a macro.
 196 .PP
 197 \&\fIBIO_set_mem_buf()\fR sets the internal \s-1BUF_MEM\s0 structure to \fBbm\fR and sets the
 198 close flag to \fBc\fR, that is \fBc\fR should be either \s-1BIO_CLOSE\s0 or \s-1BIO_NOCLOSE.\s0
 199 It is a macro.
 200 .PP
 201 \&\fIBIO_get_mem_ptr()\fR places the underlying \s-1BUF_MEM\s0 structure in \fBpp\fR. It is
 202 a macro.
 203 .PP
 204 \&\fIBIO_new_mem_buf()\fR creates a memory \s-1BIO\s0 using \fBlen\fR bytes of data at \fBbuf\fR,
 205 if \fBlen\fR is \-1 then the \fBbuf\fR is assumed to be null terminated and its
 206 length is determined by \fBstrlen\fR. The \s-1BIO\s0 is set to a read only state and
 207 as a result cannot be written to. This is useful when some data needs to be
 208 made available from a static area of memory in the form of a \s-1BIO.\s0 The
 209 supplied data is read directly from the supplied buffer: it is \fBnot\fR copied
 210 first, so the supplied area of memory must be unchanged until the \s-1BIO\s0 is freed.
 211 .SH "NOTES"
 212 .IX Header "NOTES"
 213 Writes to memory BIOs will always succeed if memory is available: that is
 214 their size can grow indefinitely.
 215 .PP
 216 Every read from a read write memory \s-1BIO\s0 will remove the data just read with
 217 an internal copy operation, if a \s-1BIO\s0 contains a lot of data and it is
 218 read in small chunks the operation can be very slow. The use of a read only
 219 memory \s-1BIO\s0 avoids this problem. If the \s-1BIO\s0 must be read write then adding
 220 a buffering \s-1BIO\s0 to the chain will speed up the process.
 221 .SH "BUGS"
 222 .IX Header "BUGS"
 223 There should be an option to set the maximum size of a memory \s-1BIO.\s0
 224 .PP
 225 There should be a way to \*(L"rewind\*(R" a read write \s-1BIO\s0 without destroying
 226 its contents.
 227 .PP
 228 The copying operation should not occur after every small read of a large \s-1BIO\s0
 229 to improve efficiency.
 230 .SH "EXAMPLE"
 231 .IX Header "EXAMPLE"
 232 Create a memory \s-1BIO\s0 and write some data to it:
 233 .PP
 234 .Vb 2
 235 \& BIO *mem = BIO_new(BIO_s_mem());
 236 \& BIO_puts(mem, "Hello World\en");
 237 .Ve
 238 .PP
 239 Create a read only memory \s-1BIO:\s0
 240 .PP
 241 .Vb 3
 242 \& char data[] = "Hello World";
 243 \& BIO *mem;
 244 \& mem = BIO_new_mem_buf(data, \-1);
 245 .Ve
 246 .PP
 247 Extract the \s-1BUF_MEM\s0 structure from a memory \s-1BIO\s0 and then free up the \s-1BIO:\s0
 248 .PP
 249 .Vb 4
 250 \& BUF_MEM *bptr;
 251 \& BIO_get_mem_ptr(mem, &bptr);
 252 \& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
 253 \& BIO_free(mem);
 254 .Ve
 255 .SH "SEE ALSO"
 256 .IX Header "SEE ALSO"
 257 \&\s-1TBA\s0