summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschwarze <>2016-11-20 01:39:11 +0000
committerschwarze <>2016-11-20 01:39:11 +0000
commit4a3145836f7a6c4104a2dc706ae4e733b8956007 (patch)
treee0ac590ef72087f75578b53a138bc7a21f17223c
parent9c7999ae75cdabf35c8bc55730e9fb1cd226e14a (diff)
downloadopenbsd-4a3145836f7a6c4104a2dc706ae4e733b8956007.tar.gz
openbsd-4a3145836f7a6c4104a2dc706ae4e733b8956007.tar.bz2
openbsd-4a3145836f7a6c4104a2dc706ae4e733b8956007.zip
Add Copyright and license.
In the SYNOPSIS, show function prototypes, not #define directives.
-rw-r--r--src/lib/libcrypto/man/BIO_should_retry.386
1 files changed, 78 insertions, 8 deletions
diff --git a/src/lib/libcrypto/man/BIO_should_retry.3 b/src/lib/libcrypto/man/BIO_should_retry.3
index f512e08b89..6a272db62a 100644
--- a/src/lib/libcrypto/man/BIO_should_retry.3
+++ b/src/lib/libcrypto/man/BIO_should_retry.3
@@ -1,6 +1,54 @@
1.\" $OpenBSD: BIO_should_retry.3,v 1.3 2016/11/07 15:52:47 jmc Exp $ 1.\" $OpenBSD: BIO_should_retry.3,v 1.4 2016/11/20 01:39:11 schwarze Exp $
2.\" OpenSSL 60e24554 Apr 6 14:45:18 2010 +0000
2.\" 3.\"
3.Dd $Mdocdate: November 7 2016 $ 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2000, 2010, 2016 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: November 20 2016 $
4.Dt BIO_SHOULD_RETRY 3 52.Dt BIO_SHOULD_RETRY 3
5.Os 53.Os
6.Sh NAME 54.Sh NAME
@@ -15,12 +63,26 @@
15.Nd BIO retry functions 63.Nd BIO retry functions
16.Sh SYNOPSIS 64.Sh SYNOPSIS
17.In openssl/bio.h 65.In openssl/bio.h
18.Pp 66.Ft int
19.Fd #define BIO_should_read(a) ((a)->flags & BIO_FLAGS_READ) 67.Fo BIO_should_read
20.Fd #define BIO_should_write(a) ((a)->flags & BIO_FLAGS_WRITE) 68.Fa "BIO *b"
21.Fd #define BIO_should_io_special(a) ((a)->flags & BIO_FLAGS_IO_SPECIAL) 69.Fc
22.Fd #define BIO_retry_type(a) ((a)->flags & BIO_FLAGS_RWS) 70.Ft int
23.Fd #define BIO_should_retry(a) ((a)->flags & BIO_FLAGS_SHOULD_RETRY) 71.Fo BIO_should_write
72.Fa "BIO *b"
73.Fc
74.Ft int
75.Fo BIO_should_io_special
76.Fa "BIO *b"
77.Fc
78.Ft int
79.Fo BIO_retry_type
80.Fa "BIO *b"
81.Fc
82.Ft int
83.Fo BIO_should_retry
84.Fa "BIO *b"
85.Fc
24.Fd #define BIO_FLAGS_READ 0x01 86.Fd #define BIO_FLAGS_READ 0x01
25.Fd #define BIO_FLAGS_WRITE 0x02 87.Fd #define BIO_FLAGS_WRITE 0x02
26.Fd #define BIO_FLAGS_IO_SPECIAL 0x04 88.Fd #define BIO_FLAGS_IO_SPECIAL 0x04
@@ -84,6 +146,14 @@ returns the reason for a special condition
84if passed the relevant BIO, for example as returned by 146if passed the relevant BIO, for example as returned by
85.Fn BIO_get_retry_BIO . 147.Fn BIO_get_retry_BIO .
86.Pp 148.Pp
149.Fn BIO_should_retry ,
150.Fn BIO_should_read ,
151.Fn BIO_should_write ,
152.Fn BIO_should_io_special ,
153and
154.Fn BIO_retry_type
155are implemented as macros.
156.Pp
87If 157If
88.Fn BIO_should_retry 158.Fn BIO_should_retry
89returns false, then the precise "error condition" depends on 159returns false, then the precise "error condition" depends on