secure/lib/libcrypto/man/BIO_s_mem.3

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH BIO_s_mem 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
 192 BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
 193 .SH "SYNOPSIS"
 194 .PP
 195 .Vb 1
 196 \& #include <openssl/bio.h>
 197 .Ve
 198 .Vb 1
 199 \& BIO_METHOD *   BIO_s_mem(void);
 200 .Ve
 201 .Vb 4
 202 \& BIO_set_mem_eof_return(BIO *b,int v)
 203 \& long BIO_get_mem_data(BIO *b, char **pp)
 204 \& BIO_set_mem_buf(BIO *b,BUF_MEM *bm,int c)
 205 \& BIO_get_mem_ptr(BIO *b,BUF_MEM **pp)
 206 .Ve
 207 .Vb 1
 208 \& BIO *BIO_new_mem_buf(void *buf, int len);
 209 .Ve
 210 .SH "DESCRIPTION"
 211 \fIBIO_s_mem()\fR return the memory BIO method function.
 212 .PP
 213 A memory BIO is a source/sink BIO which uses memory for its I/O. Data
 214 written to a memory BIO is stored in a BUF_MEM structure which is extended
 215 as appropriate to accommodate the stored data.
 216 .PP
 217 Any data written to a memory BIO can be recalled by reading from it.
 218 Unless the memory BIO is read only any data read from it is deleted from
 219 the BIO.
 220 .PP
 221 Memory BIOs support \fIBIO_gets()\fR and \fIBIO_puts()\fR.
 222 .PP
 223 If the BIO_CLOSE flag is set when a memory BIO is freed then the underlying
 224 BUF_MEM structure is also freed.
 225 .PP
 226 Calling \fIBIO_reset()\fR on a read write memory BIO clears any data in it. On a
 227 read only BIO it restores the BIO to its original state and the read only
 228 data can be read again.
 229 .PP
 230 \fIBIO_eof()\fR is true if no data is in the BIO.
 231 .PP
 232 \fIBIO_ctrl_pending()\fR returns the number of bytes currently stored.
 233 .PP
 234 \fIBIO_set_mem_eof_return()\fR sets the behaviour of memory BIO \fBb\fR when it is
 235 empty. If the \fBv\fR is zero then an empty memory BIO will return EOF (that is
 236 it will return zero and \fIBIO_should_retry\fR\|(b) will be false. If \fBv\fR is non
 237 zero then it will return \fBv\fR when it is empty and it will set the read retry
 238 flag (that is \fIBIO_read_retry\fR\|(b) is true). To avoid ambiguity with a normal
 239 positive return value \fBv\fR should be set to a negative value, typically \-1.
 240 .PP
 241 \fIBIO_get_mem_data()\fR sets \fBpp\fR to a pointer to the start of the memory BIOs data
 242 and returns the total amount of data available. It is implemented as a macro.
 243 .PP
 244 \fIBIO_set_mem_buf()\fR sets the internal BUF_MEM structure to \fBbm\fR and sets the
 245 close flag to \fBc\fR, that is \fBc\fR should be either BIO_CLOSE or BIO_NOCLOSE.
 246 It is a macro.
 247 .PP
 248 \fIBIO_get_mem_ptr()\fR places the underlying BUF_MEM structure in \fBpp\fR. It is
 249 a macro.
 250 .PP
 251 \fIBIO_new_mem_buf()\fR creates a memory BIO using \fBlen\fR bytes of data at \fBbuf\fR,
 252 if \fBlen\fR is \-1 then the \fBbuf\fR is assumed to be null terminated and its
 253 length is determined by \fBstrlen\fR. The BIO is set to a read only state and
 254 as a result cannot be written to. This is useful when some data needs to be
 255 made available from a static area of memory in the form of a BIO. The
 256 supplied data is read directly from the supplied buffer: it is \fBnot\fR copied
 257 first, so the supplied area of memory must be unchanged until the BIO is freed.
 258 .SH "NOTES"
 259 Writes to memory BIOs will always succeed if memory is available: that is
 260 their size can grow indefinitely.
 261 .PP
 262 Every read from a read write memory BIO will remove the data just read with
 263 an internal copy operation, if a BIO contains a lots of data and it is
 264 read in small chunks the operation can be very slow. The use of a read only
 265 memory BIO avoids this problem. If the BIO must be read write then adding
 266 a buffering BIO to the chain will speed up the process.
 267 .SH "BUGS"
 268 There should be an option to set the maximum size of a memory BIO.
 269 .PP
 270 There should be a way to \*(L"rewind\*(R" a read write BIO without destroying
 271 its contents.
 272 .PP
 273 The copying operation should not occur after every small read of a large BIO
 274 to improve efficiency.
 275 .SH "EXAMPLE"
 276 Create a memory BIO and write some data to it:
 277 .PP
 278 .Vb 2
 279 \& BIO *mem = BIO_new(BIO_s_mem());
 280 \& BIO_puts(mem, "Hello World\en");
 281 .Ve
 282 Create a read only memory BIO:
 283 .PP
 284 .Vb 3
 285 \& char data[] = "Hello World";
 286 \& BIO *mem;
 287 \& mem = BIO_new_mem_buf(data, -1);
 288 .Ve
 289 Extract the BUF_MEM structure from a memory BIO and then free up the BIO:
 290 .PP
 291 .Vb 5
 292 \& BUF_MEM *bptr;
 293 \& BIO_get_mem_ptr(mem, &bptr);
 294 \& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
 295 \& BIO_free(mem);
 296 \&
 297 .Ve
 298 .SH "SEE ALSO"
 299 TBA
 300
 301 .rn }` ''
 302 .IX Title "BIO_s_mem 3"
 303 .IX Name "BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
 304 BIO_get_mem_ptr, BIO_new_mem_buf - memory BIO"
 305
 306 .IX Header "NAME"
 307
 308 .IX Header "SYNOPSIS"
 309
 310 .IX Header "DESCRIPTION"
 311
 312 .IX Header "NOTES"
 313
 314 .IX Header "BUGS"
 315
 316 .IX Header "EXAMPLE"
 317
 318 .IX Header "SEE ALSO"
 319