secure/lib/libcrypto/man/BIO_s_mem.3

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