diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/BIO_set_callback.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/BIO_set_callback.3 | 50 |
1 files changed, 34 insertions, 16 deletions
diff --git a/secure/lib/libcrypto/man/man3/BIO_set_callback.3 b/secure/lib/libcrypto/man/man3/BIO_set_callback.3 index 72edf40e5fb9..a41c22135345 100644 --- a/secure/lib/libcrypto/man/man3/BIO_set_callback.3 +++ b/secure/lib/libcrypto/man/man3/BIO_set_callback.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== @@ -68,8 +68,6 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ @@ -132,14 +130,17 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "BIO_SET_CALLBACK 3" -.TH BIO_SET_CALLBACK 3 "2022-06-21" "1.1.1p" "OpenSSL" +.IX Title "BIO_SET_CALLBACK 3ossl" +.TH BIO_SET_CALLBACK 3ossl "2023-09-19" "3.0.11" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -BIO_set_callback_ex, BIO_get_callback_ex, BIO_set_callback, BIO_get_callback, BIO_set_callback_arg, BIO_get_callback_arg, BIO_debug_callback, BIO_callback_fn_ex, BIO_callback_fn \&\- BIO callback functions +BIO_set_callback_ex, BIO_get_callback_ex, BIO_set_callback, BIO_get_callback, +BIO_set_callback_arg, BIO_get_callback_arg, BIO_debug_callback, +BIO_debug_callback_ex, BIO_callback_fn_ex, BIO_callback_fn +\&\- BIO callback functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 @@ -148,17 +149,26 @@ BIO_set_callback_ex, BIO_get_callback_ex, BIO_set_callback, BIO_get_callback, BI \& typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp, \& size_t len, int argi, \& long argl, int ret, size_t *processed); -\& typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi, -\& long argl, long ret); \& \& void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback); \& BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b); \& -\& void BIO_set_callback(BIO *b, BIO_callback_fn cb); -\& BIO_callback_fn BIO_get_callback(BIO *b); \& void BIO_set_callback_arg(BIO *b, char *arg); \& char *BIO_get_callback_arg(const BIO *b); \& +\& long BIO_debug_callback_ex(BIO *bio, int oper, const char *argp, size_t len, +\& int argi, long argl, int ret, size_t *processed); +.Ve +.PP +The following functions have been deprecated since OpenSSL 3.0, and can be +hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, +see \fBopenssl_user_macros\fR\|(7): +.PP +.Vb 6 +\& typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi, +\& long argl, long ret); +\& void BIO_set_callback(BIO *b, BIO_callback_fn cb); +\& BIO_callback_fn BIO_get_callback(const BIO *b); \& long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi, \& long argl, long ret); .Ve @@ -177,12 +187,14 @@ called in preference to any set by \fBBIO_set_callback()\fR. \&\fBBIO_set_callback_arg()\fR and \fBBIO_get_callback_arg()\fR are macros which can be used to set and retrieve an argument for use in the callback. .PP -\&\fBBIO_debug_callback()\fR is a standard debugging callback which prints +\&\fBBIO_debug_callback_ex()\fR is a standard debugging callback which prints out information relating to each \s-1BIO\s0 operation. If the callback argument is set it is interpreted as a \s-1BIO\s0 to send the information -to, otherwise stderr is used. +to, otherwise stderr is used. The \fBBIO_debug_callback()\fR function is the +deprecated version of the same callback for use with the old callback +format \fBBIO_set_callback()\fR function. .PP -\&\fBBIO_callback_fn_ex()\fR is the type of the callback function and \fBBIO_callback_fn()\fR +BIO_callback_fn_ex is the type of the callback function and BIO_callback_fn is the type of the old format callback function. The meaning of each argument is described below: .IP "\fBb\fR" 4 @@ -380,13 +392,19 @@ via a call to \fBBIO_set_callback_arg()\fR. operations. .SH "EXAMPLES" .IX Header "EXAMPLES" -The \fBBIO_debug_callback()\fR function is a good example, its source is +The \fBBIO_debug_callback_ex()\fR function is an example, its source is in crypto/bio/bio_cb.c +.SH "HISTORY" +.IX Header "HISTORY" +The \fBBIO_debug_callback_ex()\fR function was added in OpenSSL 3.0. +.PP +\&\fBBIO_set_callback()\fR, \fBBIO_get_callback()\fR, and \fBBIO_debug_callback()\fR were +deprecated in OpenSSL 3.0. Use the non-deprecated _ex functions instead. .SH "COPYRIGHT" .IX Header "COPYRIGHT" -Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>. |