Add documentation for BIO functions

[openssl.git] / doc / crypto / BIO_push.pod

diff --git a/doc/crypto/BIO_push.pod b/doc/crypto/BIO_push.pod
index 8a2657cd588ca38ddc0ce9bc5478aa20281bb0c6..1523e5b6958b5ce32a65c43c4ea9abe52b1dc13b 100644 (file)
--- a/doc/crypto/BIO_push.pod
+++ b/doc/crypto/BIO_push.pod
@@ -2,14 +2,15 @@
 
 =head1 NAME
 
-BIO_push, BIO_pop - add and remove BIOs from a chain.
+BIO_push, BIO_pop, BIO_set_next - add and remove BIOs from a chain.
 
 =head1 SYNOPSIS
 
  #include <openssl/bio.h>
 
- BIO * BIO_push(BIO *b,BIO *append);
- BIO * BIO_pop(BIO *b);
+ BIO *BIO_push(BIO *b,BIO *append);
+ BIO *BIO_pop(BIO *b);
+ void BIO_set_next(BIO *b, BIO *next);
 
 =head1 DESCRIPTION
 
@@ -21,6 +22,10 @@ in the chain, or NULL if there is no next BIO. The removed BIO then
 becomes a single BIO with no association with the original chain,
 it can thus be freed or attached to a different chain.
 
+BIO_set_next() replaces the existing next BIO in a chain with the BIO pointed to
+by B<next>. The new chain may include some of the same BIOs from the old chain
+or it may be completely different.
+
 =head1 NOTES
 
 The names of these functions are perhaps a little misleading. BIO_push()
@@ -66,4 +71,10 @@ BIO.
 
 =head1 SEE ALSO
 
-TBA
+L<bio>
+
+=head1 HISTORY
+
+The BIO_set_next() function was added in OpenSSL version 1.1.0.
+
+=cut