diff options
author | Matt Caswell <matt@openssl.org> | 2016-03-29 14:25:23 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2016-03-29 17:40:54 +0100 |
commit | 85556b4dec97b1402e1edeaef6ffc0e9cd931457 (patch) | |
tree | 43a161b0a45ee1fe398d9ce3e8c9137e3557b6a1 /doc/crypto/BIO_push.pod | |
parent | 173755255837d22c2bfbfe455164c67758224cb1 (diff) |
Add documentation for BIO functions
Add the documentation for new BIO functions added as a result of
making BIO and BIO_METHOD opaque.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/crypto/BIO_push.pod')
-rw-r--r-- | doc/crypto/BIO_push.pod | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/crypto/BIO_push.pod b/doc/crypto/BIO_push.pod index 8a2657cd58..1523e5b695 100644 --- 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 |