diff options
Diffstat (limited to 'src/lib/libcrypto/man/BIO_s_socket.3')
| -rw-r--r-- | src/lib/libcrypto/man/BIO_s_socket.3 | 125 |
1 files changed, 0 insertions, 125 deletions
diff --git a/src/lib/libcrypto/man/BIO_s_socket.3 b/src/lib/libcrypto/man/BIO_s_socket.3 deleted file mode 100644 index 402622b3bd..0000000000 --- a/src/lib/libcrypto/man/BIO_s_socket.3 +++ /dev/null | |||
| @@ -1,125 +0,0 @@ | |||
| 1 | .\" $OpenBSD: BIO_s_socket.3,v 1.10 2023/04/11 16:58:43 schwarze Exp $ | ||
| 2 | .\" OpenSSL bbdc9c98 Oct 19 22:02:21 2000 +0000 | ||
| 3 | .\" | ||
| 4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
| 5 | .\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. | ||
| 6 | .\" | ||
| 7 | .\" Redistribution and use in source and binary forms, with or without | ||
| 8 | .\" modification, are permitted provided that the following conditions | ||
| 9 | .\" are met: | ||
| 10 | .\" | ||
| 11 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer. | ||
| 13 | .\" | ||
| 14 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 15 | .\" notice, this list of conditions and the following disclaimer in | ||
| 16 | .\" the documentation and/or other materials provided with the | ||
| 17 | .\" distribution. | ||
| 18 | .\" | ||
| 19 | .\" 3. All advertising materials mentioning features or use of this | ||
| 20 | .\" software must display the following acknowledgment: | ||
| 21 | .\" "This product includes software developed by the OpenSSL Project | ||
| 22 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
| 23 | .\" | ||
| 24 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
| 25 | .\" endorse or promote products derived from this software without | ||
| 26 | .\" prior written permission. For written permission, please contact | ||
| 27 | .\" openssl-core@openssl.org. | ||
| 28 | .\" | ||
| 29 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
| 30 | .\" nor may "OpenSSL" appear in their names without prior written | ||
| 31 | .\" permission of the OpenSSL Project. | ||
| 32 | .\" | ||
| 33 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
| 34 | .\" acknowledgment: | ||
| 35 | .\" "This product includes software developed by the OpenSSL Project | ||
| 36 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
| 37 | .\" | ||
| 38 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
| 39 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 40 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 41 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
| 42 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| 43 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
| 44 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| 45 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 46 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 47 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 50 | .\" | ||
| 51 | .Dd $Mdocdate: April 11 2023 $ | ||
| 52 | .Dt BIO_S_SOCKET 3 | ||
| 53 | .Os | ||
| 54 | .Sh NAME | ||
| 55 | .Nm BIO_s_socket , | ||
| 56 | .Nm BIO_new_socket | ||
| 57 | .Nd socket BIO | ||
| 58 | .Sh SYNOPSIS | ||
| 59 | .In openssl/bio.h | ||
| 60 | .Ft const BIO_METHOD * | ||
| 61 | .Fo BIO_s_socket | ||
| 62 | .Fa void | ||
| 63 | .Fc | ||
| 64 | .Ft BIO * | ||
| 65 | .Fo BIO_new_socket | ||
| 66 | .Fa "int sock" | ||
| 67 | .Fa "int close_flag" | ||
| 68 | .Fc | ||
| 69 | .Sh DESCRIPTION | ||
| 70 | .Fn BIO_s_socket | ||
| 71 | returns the socket BIO method. | ||
| 72 | This is a wrapper around the platform's socket routines. | ||
| 73 | .Pp | ||
| 74 | .Xr BIO_read 3 | ||
| 75 | and | ||
| 76 | .Xr BIO_write 3 | ||
| 77 | read or write the underlying socket. | ||
| 78 | .Xr BIO_puts 3 | ||
| 79 | is supported but | ||
| 80 | .Xr BIO_gets 3 | ||
| 81 | is not. | ||
| 82 | .Pp | ||
| 83 | If the close flag is set, then the socket is shut down and closed | ||
| 84 | when the BIO is freed. | ||
| 85 | .Pp | ||
| 86 | .Fn BIO_new_socket | ||
| 87 | returns a socket BIO using | ||
| 88 | .Fa sock | ||
| 89 | and | ||
| 90 | .Fa close_flag . | ||
| 91 | .Pp | ||
| 92 | Socket BIOs also support any relevant functionality of file descriptor BIOs. | ||
| 93 | .Pp | ||
| 94 | The reason for having separate file descriptor and socket BIOs | ||
| 95 | is that on some platforms, sockets are not file descriptors | ||
| 96 | and use distinct I/O routines. | ||
| 97 | Windows is one such platform. | ||
| 98 | Any code mixing the two will not work on all platforms. | ||
| 99 | .Sh RETURN VALUES | ||
| 100 | .Fn BIO_s_socket | ||
| 101 | returns the socket BIO method. | ||
| 102 | .Pp | ||
| 103 | .Fn BIO_new_socket | ||
| 104 | returns the newly allocated BIO or | ||
| 105 | .Dv NULL | ||
| 106 | if an error occurred. | ||
| 107 | .Pp | ||
| 108 | When called on a socket BIO object, | ||
| 109 | .Xr BIO_method_type 3 | ||
| 110 | returns the constant | ||
| 111 | .Dv BIO_TYPE_SOCKET | ||
| 112 | and | ||
| 113 | .Xr BIO_method_name 3 | ||
| 114 | returns a pointer to the static string | ||
| 115 | .Qq socket . | ||
| 116 | .Sh SEE ALSO | ||
| 117 | .Xr BIO_get_fd 3 , | ||
| 118 | .Xr BIO_new 3 | ||
| 119 | .Sh HISTORY | ||
| 120 | .Fn BIO_s_socket | ||
| 121 | first appeared in SSLeay 0.6.0. | ||
| 122 | .Fn BIO_new_socket | ||
| 123 | first appeared in SSLeay 0.8.0. | ||
| 124 | Both functions have been available since | ||
| 125 | .Ox 2.4 . | ||