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 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_METH_NEW 3ossl"
way too many mistakes in technical documents.
\fBBIO_meth_new() creates a new \s-1BIO_METHOD\s0 structure. It should be given a unique integer type and a string that represents its name. Use BIO_get_new_index() to get the value for type.
The set of standard OpenSSL provided \s-1BIO\s0 types is provided in <openssl/bio.h>. Some examples include \s-1BIO_TYPE_BUFFER\s0 and \s-1BIO_TYPE_CIPHER\s0. Filter BIOs should have a type which have the \*(L"filter\*(R" bit set (\s-1BIO_TYPE_FILTER\s0). Source/sink BIOs should have the \*(L"source/sink\*(R" bit set (\s-1BIO_TYPE_SOURCE_SINK\s0). File descriptor based BIOs (e.g. socket, fd, connect, accept etc) should additionally have the \*(L"descriptor\*(R" bit set (\s-1BIO_TYPE_DESCRIPTOR\s0). See the \fBBIO_find_type\|(3) page for more information.
\fBBIO_meth_free() destroys a \s-1BIO_METHOD\s0 structure and frees up any memory associated with it.
\fBBIO_meth_get_write_ex() and BIO_meth_set_write_ex() get and set the function used for writing arbitrary length data to the \s-1BIO\s0 respectively. This function will be called in response to the application calling BIO_write_ex() or \fBBIO_write(). The parameters for the function have the same meaning as for \fBBIO_write_ex(). Older code may call BIO_meth_get_write() and \fBBIO_meth_set_write() instead. Applications should not call both \fBBIO_meth_set_write_ex() and BIO_meth_set_write() or call BIO_meth_get_write() when the function was set with BIO_meth_set_write_ex().
\fBBIO_meth_get_read_ex() and BIO_meth_set_read_ex() get and set the function used for reading arbitrary length data from the \s-1BIO\s0 respectively. This function will be called in response to the application calling BIO_read_ex() or BIO_read(). The parameters for the function have the same meaning as for BIO_read_ex(). Older code may call BIO_meth_get_read() and BIO_meth_set_read() instead. Applications should not call both BIO_meth_set_read_ex() and BIO_meth_set_read() or call BIO_meth_get_read() when the function was set with \fBBIO_meth_set_read_ex().
\fBBIO_meth_get_puts() and BIO_meth_set_puts() get and set the function used for writing a \s-1NULL\s0 terminated string to the \s-1BIO\s0 respectively. This function will be called in response to the application calling BIO_puts(). The parameters for the function have the same meaning as for BIO_puts().
\fBBIO_meth_get_gets() and BIO_meth_set_gets() get and set the function typically used for reading a line of data from the \s-1BIO\s0 respectively (see the BIO_gets\|(3) page for more information). This function will be called in response to the application calling BIO_gets(). The parameters for the function have the same meaning as for BIO_gets().
\fBBIO_meth_get_ctrl() and BIO_meth_set_ctrl() get and set the function used for processing ctrl messages in the \s-1BIO\s0 respectively. See the BIO_ctrl\|(3) page for more information. This function will be called in response to the application calling BIO_ctrl(). The parameters for the function have the same meaning as for \fBBIO_ctrl().
\fBBIO_meth_get_create() and BIO_meth_set_create() get and set the function used for creating a new instance of the \s-1BIO\s0 respectively. This function will be called in response to the application calling BIO_new() and passing in a pointer to the current \s-1BIO_METHOD.\s0 The BIO_new() function will allocate the memory for the new \s-1BIO,\s0 and a pointer to this newly allocated structure will be passed as a parameter to the function. If a create function is set, \fBBIO_new() will not mark the \s-1BIO\s0 as initialised on allocation. \fBBIO_set_init\|(3) must then be called either by the create function, or later, by a \s-1BIO\s0 ctrl function, once \s-1BIO\s0 initialisation is complete.
\fBBIO_meth_get_destroy() and BIO_meth_set_destroy() get and set the function used for destroying an instance of a \s-1BIO\s0 respectively. This function will be called in response to the application calling BIO_free(). A pointer to the \s-1BIO\s0 to be destroyed is passed as a parameter. The destroy function should be used for \s-1BIO\s0 specific clean up. The memory for the \s-1BIO\s0 itself should not be freed by this function.
\fBBIO_meth_get_callback_ctrl() and BIO_meth_set_callback_ctrl() get and set the function used for processing callback ctrl messages in the \s-1BIO\s0 respectively. See the BIO_callback_ctrl\|(3) page for more information. This function will be called in response to the application calling BIO_callback_ctrl(). The parameters for the function have the same meaning as for BIO_callback_ctrl().
BIO_meth_new(int type, const char *name) returns a valid \s-1BIO_METHOD\s0 or \s-1NULL\s0 if an error occurred.
The BIO_meth_set functions return 1 on success or 0 on error.
The BIO_meth_get functions return the corresponding function pointers.
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>.