diff options
| author | bentley <> | 2014-10-12 09:33:04 +0000 |
|---|---|---|
| committer | bentley <> | 2014-10-12 09:33:04 +0000 |
| commit | 78332233d01faa45e0bb0b1583d47cb5ad1ddc19 (patch) | |
| tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_get_fd.3 | |
| parent | 4e737c824fafe5f105e5f4849a9db2569b5d53d8 (diff) | |
| download | openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.tar.gz openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.tar.bz2 openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.zip | |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_fd.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_get_fd.3 | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_fd.3 b/src/lib/libssl/doc/SSL_get_fd.3 new file mode 100644 index 0000000000..458e73dacc --- /dev/null +++ b/src/lib/libssl/doc/SSL_get_fd.3 | |||
| @@ -0,0 +1,43 @@ | |||
| 1 | .Dd $Mdocdate: October 12 2014 $ | ||
| 2 | .Dt SSL_GET_FD 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm SSL_get_fd , | ||
| 6 | .Nm SSL_get_rfd , | ||
| 7 | .Nm SSL_get_wfd | ||
| 8 | .Nd get file descriptor linked to an SSL object | ||
| 9 | .Sh SYNOPSIS | ||
| 10 | .In openssl/ssl.h | ||
| 11 | .Ft int | ||
| 12 | .Fn SSL_get_fd "const SSL *ssl" | ||
| 13 | .Ft int | ||
| 14 | .Fn SSL_get_rfd "const SSL *ssl" | ||
| 15 | .Ft int | ||
| 16 | .Fn SSL_get_wfd "const SSL *ssl" | ||
| 17 | .Sh DESCRIPTION | ||
| 18 | .Fn SSL_get_fd | ||
| 19 | returns the file descriptor which is linked to | ||
| 20 | .Fa ssl . | ||
| 21 | .Fn SSL_get_rfd | ||
| 22 | and | ||
| 23 | .Fn SSL_get_wfd | ||
| 24 | return the file descriptors for the read or the write channel, | ||
| 25 | which can be different. | ||
| 26 | If the read and the write channel are different, | ||
| 27 | .Fn SSL_get_fd | ||
| 28 | will return the file descriptor of the read channel. | ||
| 29 | .Sh RETURN VALUES | ||
| 30 | The following return values can occur: | ||
| 31 | .Bl -tag -width Ds | ||
| 32 | .It \(mi1 | ||
| 33 | The operation failed, because the underlying | ||
| 34 | .Vt BIO | ||
| 35 | is not of the correct type (suitable for file descriptors). | ||
| 36 | .It \(>=0 | ||
| 37 | The file descriptor linked to | ||
| 38 | .Fa ssl . | ||
| 39 | .El | ||
| 40 | .Sh SEE ALSO | ||
| 41 | .Xr bio 3 , | ||
| 42 | .Xr ssl 3 , | ||
| 43 | .Xr SSL_set_fd 3 | ||
