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