Add copyright to manpages
[openssl.git] / doc / crypto / BIO_s_mem.pod
index b9ce5da6e2e3fab3bc83a640e040949e1b239a8e..08c2f9289e390fcc975c1b5a3bd222490a2cff8a 100644 (file)
@@ -9,8 +9,8 @@ BIO_get_mem_ptr, BIO_new_mem_buf - memory BIO
 
  #include <openssl/bio.h>
 
BIO_METHOD *  BIO_s_mem(void);
BIO_METHOD *  BIO_s_secmem(void);
const BIO_METHOD *    BIO_s_mem(void);
const BIO_METHOD *    BIO_s_secmem(void);
 
  BIO_set_mem_eof_return(BIO *b,int v)
  long BIO_get_mem_data(BIO *b, char **pp)
@@ -39,9 +39,10 @@ Memory BIOs support BIO_gets() and BIO_puts().
 If the BIO_CLOSE flag is set when a memory BIO is freed then the underlying
 BUF_MEM structure is also freed.
 
-Calling BIO_reset() on a read write memory BIO clears any data in it. On a
-read only BIO it restores the BIO to its original state and the read only
-data can be read again.
+Calling BIO_reset() on a read write memory BIO clears any data in it if the
+flag BIO_FLAGS_NONCLEAR_RST is not set. On a read only BIO or if the flag
+BIO_FLAGS_NONCLEAR_RST is set it restores the BIO to its original state and 
+the data can be read again.
 
 BIO_eof() is true if no data is in the BIO.
 
@@ -90,12 +91,6 @@ give undefined results, including perhaps a program crash.
 
 There should be an option to set the maximum size of a memory BIO.
 
-There should be a way to "rewind" a read write BIO without destroying
-its contents.
-
-The copying operation should not occur after every small read of a large BIO
-to improve efficiency.
-
 =head1 EXAMPLE
 
 Create a memory BIO and write some data to it:
@@ -120,3 +115,16 @@ Extract the BUF_MEM structure from a memory BIO and then free up the BIO:
 =head1 SEE ALSO
 
 TBA
+
+=cut
+
+=head1 COPYRIGHT
+
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (the "License").  You may not use
+this file except in compliance with the License.  You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+
+=cut