diff options
author | nectar <nectar@FreeBSD.org> | 2005-02-25 06:04:12 +0000 |
---|---|---|
committer | nectar <nectar@FreeBSD.org> | 2005-02-25 06:04:12 +0000 |
commit | deac0ae54c501cec8549d18e9482a730cc2d4b97 (patch) | |
tree | cc99086df80af0d12671c7151a7b49233e19f39d /secure/lib/libcrypto/man/BIO_s_bio.3 | |
parent | ced877b043d77d97f1ad196f15b25ed720c1fcdc (diff) | |
download | FreeBSD-src-deac0ae54c501cec8549d18e9482a730cc2d4b97.zip FreeBSD-src-deac0ae54c501cec8549d18e9482a730cc2d4b97.tar.gz |
Update OpenSSL 0.9.7d -> 0.9.7e.
Diffstat (limited to 'secure/lib/libcrypto/man/BIO_s_bio.3')
-rw-r--r-- | secure/lib/libcrypto/man/BIO_s_bio.3 | 55 |
1 files changed, 28 insertions, 27 deletions
diff --git a/secure/lib/libcrypto/man/BIO_s_bio.3 b/secure/lib/libcrypto/man/BIO_s_bio.3 index e14695f..133dd63 100644 --- a/secure/lib/libcrypto/man/BIO_s_bio.3 +++ b/secure/lib/libcrypto/man/BIO_s_bio.3 @@ -1,8 +1,7 @@ -.\" Automatically generated by Pod::Man version 1.15 -.\" Wed Mar 17 09:38:29 2004 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: -.\" ====================================================================== +.\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp @@ -15,12 +14,6 @@ .if t .sp .5v .if n .sp .. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. .de Vb \" Begin verbatim text .ft CW .nf @@ -28,15 +21,14 @@ .. .de Ve \" End verbatim text .ft R - .fi .. .\" 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. | will give a -.\" real vertical bar. \*(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<> +.\" real vertical bar. \*(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-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ @@ -56,10 +48,10 @@ . ds R" '' 'br\} .\" -.\" If the F register is turned on, we'll generate index entries on stderr -.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and -.\" index entries marked with X<> in POD. Of course, you'll have to process -.\" the output yourself in some meaningful fashion. +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" @@ -68,14 +60,13 @@ . rr F .\} .\" -.\" For nroff, turn off justification. Always turn off hyphenation; it -.\" makes way too many mistakes in technical documents. +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. -.bd B 3 . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 @@ -135,46 +126,53 @@ . ds Ae AE .\} .rm #[ #] #H #V #F C -.\" ====================================================================== +.\" ======================================================================== .\" .IX Title "BIO_s_bio 3" -.TH BIO_s_bio 3 "0.9.7d" "2004-03-17" "OpenSSL" -.UC +.TH BIO_s_bio 3 "2005-02-24" "0.9.7d" "OpenSSL" .SH "NAME" BIO_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_shutdown_wr, BIO_set_write_buf_size, BIO_get_write_buf_size, BIO_new_bio_pair, BIO_get_write_guarantee, BIO_ctrl_get_write_guarantee, BIO_get_read_request, -BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request \- \s-1BIO\s0 pair \s-1BIO\s0 +BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request \- BIO pair BIO .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/bio.h> .Ve +.PP .Vb 1 \& BIO_METHOD *BIO_s_bio(void); .Ve +.PP .Vb 2 \& #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2) \& #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL) .Ve +.PP .Vb 1 \& #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL) .Ve +.PP .Vb 2 \& #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL) \& #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL) .Ve +.PP .Vb 1 \& int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2); .Ve +.PP .Vb 2 \& #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL) \& size_t BIO_ctrl_get_write_guarantee(BIO *b); .Ve +.PP .Vb 2 \& #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL) \& size_t BIO_ctrl_get_read_request(BIO *b); .Ve +.PP .Vb 1 \& int BIO_ctrl_reset_read_request(BIO *b); .Ve @@ -276,7 +274,7 @@ locations for \fBbio1\fR and \fBbio2\fR. Check the error stack for more informat .IX Header "EXAMPLE" The \s-1BIO\s0 pair can be used to have full control over the network access of an application. The application can call \fIselect()\fR on the socket as required -without having to go through the SSL-interface. +without having to go through the SSL\-interface. .PP .Vb 6 \& BIO *internal_bio, *network_bio; @@ -286,6 +284,7 @@ without having to go through the SSL-interface. \& SSL_operations(); \& ... .Ve +.PP .Vb 9 \& application | TLS-engine \& | | @@ -297,12 +296,14 @@ without having to go through the SSL-interface. \& | | \& socket | .Ve +.PP .Vb 4 \& ... \& SSL_free(ssl); /* implicitly frees internal_bio */ \& BIO_free(network_bio); \& ... .Ve +.PP As the \s-1BIO\s0 pair will only buffer the data and never directly access the connection, it behaves non-blocking and will return as soon as the write buffer is full or the read buffer is drained. Then the application has to @@ -321,5 +322,5 @@ write buffer is always flushed first. Otherwise a deadlock may occur as the peer might be waiting for the data before being able to continue. .SH "SEE ALSO" .IX Header "SEE ALSO" -SSL_set_bio(3), ssl(3), bio(3), -BIO_should_retry(3), BIO_read(3) +\&\fISSL_set_bio\fR\|(3), \fIssl\fR\|(3), \fIbio\fR\|(3), +\&\fIBIO_should_retry\fR\|(3), \fIBIO_read\fR\|(3) |