1aa7e6ebf9190551e6fc9152a28d1eae7d6ac147
[openssl.git] / doc / crypto / BIO_s_mem.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf,
6 BIO_get_mem_ptr, BIO_new_mem_buf - memory BIO
7
8 =head1 SYNOPSIS
9
10  #include <openssl/bio.h>
11
12  BIO_METHOD *   BIO_s_mem(void);
13  BIO_METHOD *   BIO_s_secmem(void);
14
15  BIO_set_mem_eof_return(BIO *b,int v)
16  long BIO_get_mem_data(BIO *b, char **pp)
17  BIO_set_mem_buf(BIO *b,BUF_MEM *bm,int c)
18  BIO_get_mem_ptr(BIO *b,BUF_MEM **pp)
19
20  BIO *BIO_new_mem_buf(void *buf, int len);
21
22 =head1 DESCRIPTION
23
24 BIO_s_mem() return the memory BIO method function. 
25
26 A memory BIO is a source/sink BIO which uses memory for its I/O. Data
27 written to a memory BIO is stored in a BUF_MEM structure which is extended
28 as appropriate to accommodate the stored data.
29
30 BIO_s_secmem() is like BIO_s_mem() except that the secure heap is used
31 for buffer storage.
32
33 Any data written to a memory BIO can be recalled by reading from it.
34 Unless the memory BIO is read only any data read from it is deleted from
35 the BIO.
36
37 Memory BIOs support BIO_gets() and BIO_puts().
38
39 If the BIO_CLOSE flag is set when a memory BIO is freed then the underlying
40 BUF_MEM structure is also freed.
41
42 Calling BIO_reset() on a read write memory BIO clears any data in it. On a
43 read only BIO it restores the BIO to its original state and the read only
44 data can be read again.
45
46 BIO_eof() is true if no data is in the BIO.
47
48 BIO_ctrl_pending() returns the number of bytes currently stored.
49
50 BIO_set_mem_eof_return() sets the behaviour of memory BIO B<b> when it is
51 empty. If the B<v> is zero then an empty memory BIO will return EOF (that is
52 it will return zero and BIO_should_retry(b) will be false. If B<v> is non
53 zero then it will return B<v> when it is empty and it will set the read retry
54 flag (that is BIO_read_retry(b) is true). To avoid ambiguity with a normal
55 positive return value B<v> should be set to a negative value, typically -1.
56
57 BIO_get_mem_data() sets B<pp> to a pointer to the start of the memory BIOs data
58 and returns the total amount of data available. It is implemented as a macro.
59
60 BIO_set_mem_buf() sets the internal BUF_MEM structure to B<bm> and sets the
61 close flag to B<c>, that is B<c> should be either BIO_CLOSE or BIO_NOCLOSE.
62 It is a macro.
63
64 BIO_get_mem_ptr() places the underlying BUF_MEM structure in B<pp>. It is
65 a macro.
66
67 BIO_new_mem_buf() creates a memory BIO using B<len> bytes of data at B<buf>,
68 if B<len> is -1 then the B<buf> is assumed to be null terminated and its
69 length is determined by B<strlen>. The BIO is set to a read only state and
70 as a result cannot be written to. This is useful when some data needs to be
71 made available from a static area of memory in the form of a BIO. The
72 supplied data is read directly from the supplied buffer: it is B<not> copied
73 first, so the supplied area of memory must be unchanged until the BIO is freed.
74
75 =head1 NOTES
76
77 Writes to memory BIOs will always succeed if memory is available: that is
78 their size can grow indefinitely.
79
80 Every read from a read write memory BIO will remove the data just read with
81 an internal copy operation, if a BIO contains a lot of data and it is
82 read in small chunks the operation can be very slow. The use of a read only
83 memory BIO avoids this problem. If the BIO must be read write then adding
84 a buffering BIO to the chain will speed up the process.
85
86 Calling BIO_set_mem_buf() on a BIO created with BIO_new_secmem() will
87 give undefined results, including perhaps a program crash.
88
89 =head1 BUGS
90
91 There should be an option to set the maximum size of a memory BIO.
92
93 There should be a way to "rewind" a read write BIO without destroying
94 its contents.
95
96 The copying operation should not occur after every small read of a large BIO
97 to improve efficiency.
98
99 =head1 EXAMPLE
100
101 Create a memory BIO and write some data to it:
102
103  BIO *mem = BIO_new(BIO_s_mem());
104  BIO_puts(mem, "Hello World\n"); 
105
106 Create a read only memory BIO:
107
108  char data[] = "Hello World";
109  BIO *mem;
110  mem = BIO_new_mem_buf(data, -1);
111
112 Extract the BUF_MEM structure from a memory BIO and then free up the BIO:
113
114  BUF_MEM *bptr;
115  BIO_get_mem_ptr(mem, &bptr);
116  BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
117  BIO_free(mem);
118  
119
120 =head1 SEE ALSO
121
122 TBA