openssl: Adjust manual pages for 1.0.1o.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_mem.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 turned on, 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_s_mem 3"
136 .TH BIO_s_mem 3 "2015-06-12" "1.0.1o" "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_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
143 BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 .Vb 1
147 \& #include <openssl/bio.h>
148 \&
149 \& BIO_METHOD *   BIO_s_mem(void);
150 \&
151 \& BIO_set_mem_eof_return(BIO *b,int v)
152 \& long BIO_get_mem_data(BIO *b, char **pp)
153 \& BIO_set_mem_buf(BIO *b,BUF_MEM *bm,int c)
154 \& BIO_get_mem_ptr(BIO *b,BUF_MEM **pp)
155 \&
156 \& BIO *BIO_new_mem_buf(void *buf, int len);
157 .Ve
158 .SH "DESCRIPTION"
159 .IX Header "DESCRIPTION"
160 \&\fIBIO_s_mem()\fR return the memory \s-1BIO\s0 method function.
161 .PP
162 A memory \s-1BIO\s0 is a source/sink \s-1BIO\s0 which uses memory for its I/O. Data
163 written to a memory \s-1BIO\s0 is stored in a \s-1BUF_MEM\s0 structure which is extended
164 as appropriate to accommodate the stored data.
165 .PP
166 Any data written to a memory \s-1BIO\s0 can be recalled by reading from it.
167 Unless the memory \s-1BIO\s0 is read only any data read from it is deleted from
168 the \s-1BIO.\s0
169 .PP
170 Memory BIOs support \fIBIO_gets()\fR and \fIBIO_puts()\fR.
171 .PP
172 If the \s-1BIO_CLOSE\s0 flag is set when a memory \s-1BIO\s0 is freed then the underlying
173 \&\s-1BUF_MEM\s0 structure is also freed.
174 .PP
175 Calling \fIBIO_reset()\fR on a read write memory \s-1BIO\s0 clears any data in it. On a
176 read only \s-1BIO\s0 it restores the \s-1BIO\s0 to its original state and the read only
177 data can be read again.
178 .PP
179 \&\fIBIO_eof()\fR is true if no data is in the \s-1BIO.\s0
180 .PP
181 \&\fIBIO_ctrl_pending()\fR returns the number of bytes currently stored.
182 .PP
183 \&\fIBIO_set_mem_eof_return()\fR sets the behaviour of memory \s-1BIO \s0\fBb\fR when it is
184 empty. If the \fBv\fR is zero then an empty memory \s-1BIO\s0 will return \s-1EOF \s0(that is
185 it will return zero and BIO_should_retry(b) will be false. If \fBv\fR is non
186 zero then it will return \fBv\fR when it is empty and it will set the read retry
187 flag (that is BIO_read_retry(b) is true). To avoid ambiguity with a normal
188 positive return value \fBv\fR should be set to a negative value, typically \-1.
189 .PP
190 \&\fIBIO_get_mem_data()\fR sets \fBpp\fR to a pointer to the start of the memory BIOs data
191 and returns the total amount of data available. It is implemented as a macro.
192 .PP
193 \&\fIBIO_set_mem_buf()\fR sets the internal \s-1BUF_MEM\s0 structure to \fBbm\fR and sets the
194 close flag to \fBc\fR, that is \fBc\fR should be either \s-1BIO_CLOSE\s0 or \s-1BIO_NOCLOSE.\s0
195 It is a macro.
196 .PP
197 \&\fIBIO_get_mem_ptr()\fR places the underlying \s-1BUF_MEM\s0 structure in \fBpp\fR. It is
198 a macro.
199 .PP
200 \&\fIBIO_new_mem_buf()\fR creates a memory \s-1BIO\s0 using \fBlen\fR bytes of data at \fBbuf\fR,
201 if \fBlen\fR is \-1 then the \fBbuf\fR is assumed to be null terminated and its
202 length is determined by \fBstrlen\fR. The \s-1BIO\s0 is set to a read only state and
203 as a result cannot be written to. This is useful when some data needs to be
204 made available from a static area of memory in the form of a \s-1BIO.\s0 The
205 supplied data is read directly from the supplied buffer: it is \fBnot\fR copied
206 first, so the supplied area of memory must be unchanged until the \s-1BIO\s0 is freed.
207 .SH "NOTES"
208 .IX Header "NOTES"
209 Writes to memory BIOs will always succeed if memory is available: that is
210 their size can grow indefinitely.
211 .PP
212 Every read from a read write memory \s-1BIO\s0 will remove the data just read with
213 an internal copy operation, if a \s-1BIO\s0 contains a lot of data and it is
214 read in small chunks the operation can be very slow. The use of a read only
215 memory \s-1BIO\s0 avoids this problem. If the \s-1BIO\s0 must be read write then adding
216 a buffering \s-1BIO\s0 to the chain will speed up the process.
217 .SH "BUGS"
218 .IX Header "BUGS"
219 There should be an option to set the maximum size of a memory \s-1BIO.\s0
220 .PP
221 There should be a way to \*(L"rewind\*(R" a read write \s-1BIO\s0 without destroying
222 its contents.
223 .PP
224 The copying operation should not occur after every small read of a large \s-1BIO\s0
225 to improve efficiency.
226 .SH "EXAMPLE"
227 .IX Header "EXAMPLE"
228 Create a memory \s-1BIO\s0 and write some data to it:
229 .PP
230 .Vb 2
231 \& BIO *mem = BIO_new(BIO_s_mem());
232 \& BIO_puts(mem, "Hello World\en");
233 .Ve
234 .PP
235 Create a read only memory \s-1BIO:\s0
236 .PP
237 .Vb 3
238 \& char data[] = "Hello World";
239 \& BIO *mem;
240 \& mem = BIO_new_mem_buf(data, \-1);
241 .Ve
242 .PP
243 Extract the \s-1BUF_MEM\s0 structure from a memory \s-1BIO\s0 and then free up the \s-1BIO:\s0
244 .PP
245 .Vb 4
246 \& BUF_MEM *bptr;
247 \& BIO_get_mem_ptr(mem, &bptr);
248 \& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
249 \& BIO_free(mem);
250 .Ve
251 .SH "SEE ALSO"
252 .IX Header "SEE ALSO"
253 \&\s-1TBA\s0