1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
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'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
51.ie \nF \{\
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
--- 48 unchanged lines hidden (view full) ---
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "BIO_s_mem 3"
127.TH BIO_s_mem 3 "2010-11-16" "0.9.8p" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
132.SH "NAME"
133BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
134BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& #include <openssl/bio.h>
139\&
140\& BIO_METHOD * BIO_s_mem(void);
141\&
142\& BIO_set_mem_eof_return(BIO *b,int v)
143\& long BIO_get_mem_data(BIO *b, char **pp)
144\& BIO_set_mem_buf(BIO *b,BUF_MEM *bm,int c)
145\& BIO_get_mem_ptr(BIO *b,BUF_MEM **pp)
146\&
147\& BIO *BIO_new_mem_buf(void *buf, int len);
148.Ve
149.SH "DESCRIPTION"
150.IX Header "DESCRIPTION"
151\&\fIBIO_s_mem()\fR return the memory \s-1BIO\s0 method function.
152.PP
153A memory \s-1BIO\s0 is a source/sink \s-1BIO\s0 which uses memory for its I/O. Data
154written to a memory \s-1BIO\s0 is stored in a \s-1BUF_MEM\s0 structure which is extended
155as appropriate to accommodate the stored data.
156.PP
157Any data written to a memory \s-1BIO\s0 can be recalled by reading from it.
158Unless the memory \s-1BIO\s0 is read only any data read from it is deleted from
159the \s-1BIO\s0.
--- 63 unchanged lines hidden (view full) ---
223\& BIO_puts(mem, "Hello World\en");
224.Ve
225.PP
226Create a read only memory \s-1BIO:\s0
227.PP
228.Vb 3
229\& char data[] = "Hello World";
230\& BIO *mem;
231\& mem = BIO_new_mem_buf(data, \-1);
232.Ve
233.PP
234Extract the \s-1BUF_MEM\s0 structure from a memory \s-1BIO\s0 and then free up the \s-1BIO:\s0
235.PP
236.Vb 4
237\& BUF_MEM *bptr;
238\& BIO_get_mem_ptr(mem, &bptr);
239\& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
240\& BIO_free(mem);
241.Ve
242.SH "SEE ALSO"
243.IX Header "SEE ALSO"
244\&\s-1TBA\s0
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'br\}
42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
51.ie \nF \{\
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
58.el \{\
59. de IX
60..
61.\}
62.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
--- 48 unchanged lines hidden (view full) ---
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "BIO_s_mem 3"
127.TH BIO_s_mem 3 "2010-11-16" "0.9.8p" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
132.SH "NAME"
133BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
134BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& #include <openssl/bio.h>
139\&
140\& BIO_METHOD * BIO_s_mem(void);
141\&
142\& BIO_set_mem_eof_return(BIO *b,int v)
143\& long BIO_get_mem_data(BIO *b, char **pp)
144\& BIO_set_mem_buf(BIO *b,BUF_MEM *bm,int c)
145\& BIO_get_mem_ptr(BIO *b,BUF_MEM **pp)
146\&
147\& BIO *BIO_new_mem_buf(void *buf, int len);
148.Ve
149.SH "DESCRIPTION"
150.IX Header "DESCRIPTION"
151\&\fIBIO_s_mem()\fR return the memory \s-1BIO\s0 method function.
152.PP
153A memory \s-1BIO\s0 is a source/sink \s-1BIO\s0 which uses memory for its I/O. Data
154written to a memory \s-1BIO\s0 is stored in a \s-1BUF_MEM\s0 structure which is extended
155as appropriate to accommodate the stored data.
156.PP
157Any data written to a memory \s-1BIO\s0 can be recalled by reading from it.
158Unless the memory \s-1BIO\s0 is read only any data read from it is deleted from
159the \s-1BIO\s0.
--- 63 unchanged lines hidden (view full) ---
223\& BIO_puts(mem, "Hello World\en");
224.Ve
225.PP
226Create a read only memory \s-1BIO:\s0
227.PP
228.Vb 3
229\& char data[] = "Hello World";
230\& BIO *mem;
231\& mem = BIO_new_mem_buf(data, \-1);
232.Ve
233.PP
234Extract the \s-1BUF_MEM\s0 structure from a memory \s-1BIO\s0 and then free up the \s-1BIO:\s0
235.PP
236.Vb 4
237\& BUF_MEM *bptr;
238\& BIO_get_mem_ptr(mem, &bptr);
239\& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
240\& BIO_free(mem);
241.Ve
242.SH "SEE ALSO"
243.IX Header "SEE ALSO"
244\&\s-1TBA\s0