Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .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 . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "BIO_SET_CALLBACK 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
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 Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& 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); \& 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_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

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):

.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

Header "DESCRIPTION" \fBBIO_set_callback_ex() and BIO_get_callback_ex() set and retrieve the \s-1BIO\s0 callback. The callback is called during most high-level \s-1BIO\s0 operations. It can be used for debugging purposes to trace operations on a \s-1BIO\s0 or to modify its operation.

\fBBIO_set_callback() and BIO_get_callback() set and retrieve the old format \s-1BIO\s0 callback. New code should not use these functions, but they are retained for backwards compatibility. Any callback set via BIO_set_callback_ex() will get called in preference to any set by BIO_set_callback().

\fBBIO_set_callback_arg() and BIO_get_callback_arg() are macros which can be used to set and retrieve an argument for use in the callback.

\fBBIO_debug_callback_ex() 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. The BIO_debug_callback() function is the deprecated version of the same callback for use with the old callback format BIO_set_callback() function.

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:

Item "b" The \s-1BIO\s0 the callback is attached to is passed in b. Item "oper" \fBoper is set to the operation being performed. For some operations the callback is called twice, once before and once after the actual operation, the latter case has oper or'ed with \s-1BIO_CB_RETURN.\s0 Item "len" The length of the data requested to be read or written. This is only useful if \fBoper is \s-1BIO_CB_READ, BIO_CB_WRITE\s0 or \s-1BIO_CB_GETS.\s0 Item "argp argi argl" The meaning of the arguments argp, argi and argl depends on the value of oper, that is the operation being performed. Item "processed" \fBprocessed is a pointer to a location which will be updated with the amount of data that was actually read or written. Only used for \s-1BIO_CB_READ, BIO_CB_WRITE, BIO_CB_GETS\s0 and \s-1BIO_CB_PUTS.\s0 Item "ret" \fBret is the return value that would be returned to the application if no callback were present. The actual value returned is the return value of the callback itself. In the case of callbacks called before the actual \s-1BIO\s0 operation 1 is placed in ret, if the return value is not positive it will be immediately returned to the application and the \s-1BIO\s0 operation will not be performed.

The callback should normally simply return ret when it has finished processing, unless it specifically wishes to modify the value returned to the application.

Header "CALLBACK OPERATIONS" In the notes below, callback defers to the actual callback function that is called. Item "BIO_free(b)" .Vb 1 callback_ex(b, BIO_CB_FREE, NULL, 0, 0, 0L, 1L, NULL) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_FREE, NULL, 0L, 0L, 1L) .Ve .Sp is called before the free operation. Item "BIO_read_ex(b, data, dlen, readbytes)" .Vb 1 callback_ex(b, BIO_CB_READ, data, dlen, 0, 0L, 1L, NULL) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_READ, data, dlen, 0L, 1L) .Ve .Sp is called before the read and .Sp .Vb 2 callback_ex(b, BIO_CB_READ | BIO_CB_RETURN, data, dlen, 0, 0L, retvalue, &readbytes) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_READ|BIO_CB_RETURN, data, dlen, 0L, retvalue) .Ve .Sp after. Item "BIO_write(b, data, dlen, written)" .Vb 1 callback_ex(b, BIO_CB_WRITE, data, dlen, 0, 0L, 1L, NULL) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_WRITE, datat, dlen, 0L, 1L) .Ve .Sp is called before the write and .Sp .Vb 2 callback_ex(b, BIO_CB_WRITE | BIO_CB_RETURN, data, dlen, 0, 0L, retvalue, &written) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_WRITE|BIO_CB_RETURN, data, dlen, 0L, retvalue) .Ve .Sp after. Item "BIO_gets(b, buf, size)" .Vb 1 callback_ex(b, BIO_CB_GETS, buf, size, 0, 0L, 1, NULL, NULL) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_GETS, buf, size, 0L, 1L) .Ve .Sp is called before the operation and .Sp .Vb 2 callback_ex(b, BIO_CB_GETS | BIO_CB_RETURN, buf, size, 0, 0L, retvalue, &readbytes) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_GETS|BIO_CB_RETURN, buf, size, 0L, retvalue) .Ve .Sp after. Item "BIO_puts(b, buf)" .Vb 1 callback_ex(b, BIO_CB_PUTS, buf, 0, 0, 0L, 1L, NULL); .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_PUTS, buf, 0, 0L, 1L) .Ve .Sp is called before the operation and .Sp .Vb 1 callback_ex(b, BIO_CB_PUTS | BIO_CB_RETURN, buf, 0, 0, 0L, retvalue, &written) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_PUTS|BIO_CB_RETURN, buf, 0, 0L, retvalue) .Ve .Sp after. Item "BIO_ctrl(BIO *b, int cmd, long larg, void *parg)" .Vb 1 callback_ex(b, BIO_CB_CTRL, parg, 0, cmd, larg, 1L, NULL) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_CTRL, parg, cmd, larg, 1L) .Ve .Sp is called before the call and .Sp .Vb 1 callback_ex(b, BIO_CB_CTRL | BIO_CB_RETURN, parg, 0, cmd, larg, ret, NULL) .Ve .Sp or .Sp .Vb 1 callback(b, BIO_CB_CTRL|BIO_CB_RETURN, parg, cmd, larg, ret) .Ve .Sp after. .Sp Note: cmd == \s-1BIO_CTRL_SET_CALLBACK\s0 is special, because parg is not the argument of type BIO_info_cb itself. In this case parg is a pointer to the actual call parameter, see BIO_callback_ctrl. Header "RETURN VALUES" \fBBIO_get_callback_ex() and BIO_get_callback() return the callback function previously set by a call to BIO_set_callback_ex() and BIO_set_callback() respectively.

\fBBIO_get_callback_arg() returns a char pointer to the value previously set via a call to BIO_set_callback_arg().

\fBBIO_debug_callback() returns 1 or ret if it's called after specific \s-1BIO\s0 operations.

Header "EXAMPLES" The BIO_debug_callback_ex() function is an example, its source is in crypto/bio/bio_cb.c Header "HISTORY" The BIO_debug_callback_ex() function was added in OpenSSL 3.0.

\fBBIO_set_callback(), BIO_get_callback(), and BIO_debug_callback() were deprecated in OpenSSL 3.0. Use the non-deprecated _ex functions instead.

Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

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>.