diff options
-rw-r--r-- | src/lib/libcrypto/man/BIO_get_data.3 | 100 |
1 files changed, 95 insertions, 5 deletions
diff --git a/src/lib/libcrypto/man/BIO_get_data.3 b/src/lib/libcrypto/man/BIO_get_data.3 index dd7858b771..51b10adbb4 100644 --- a/src/lib/libcrypto/man/BIO_get_data.3 +++ b/src/lib/libcrypto/man/BIO_get_data.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: BIO_get_data.3,v 1.5 2022/12/17 22:21:24 schwarze Exp $ | 1 | .\" $OpenBSD: BIO_get_data.3,v 1.6 2022/12/18 21:45:47 schwarze Exp $ |
2 | .\" full merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 | 2 | .\" full merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 |
3 | .\" | 3 | .\" |
4 | .\" This file is a derived work. | 4 | .\" This file is a derived work. |
@@ -65,7 +65,7 @@ | |||
65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
67 | .\" | 67 | .\" |
68 | .Dd $Mdocdate: December 17 2022 $ | 68 | .Dd $Mdocdate: December 18 2022 $ |
69 | .Dt BIO_GET_DATA 3 | 69 | .Dt BIO_GET_DATA 3 |
70 | .Os | 70 | .Os |
71 | .Sh NAME | 71 | .Sh NAME |
@@ -75,6 +75,11 @@ | |||
75 | .Nm BIO_clear_flags , | 75 | .Nm BIO_clear_flags , |
76 | .Nm BIO_test_flags , | 76 | .Nm BIO_test_flags , |
77 | .Nm BIO_get_flags , | 77 | .Nm BIO_get_flags , |
78 | .Nm BIO_set_retry_read , | ||
79 | .Nm BIO_set_retry_write , | ||
80 | .Nm BIO_set_retry_special , | ||
81 | .Nm BIO_clear_retry_flags , | ||
82 | .Nm BIO_get_retry_flags , | ||
78 | .Nm BIO_set_init , | 83 | .Nm BIO_set_init , |
79 | .Nm BIO_get_init , | 84 | .Nm BIO_get_init , |
80 | .Nm BIO_set_shutdown , | 85 | .Nm BIO_set_shutdown , |
@@ -111,6 +116,26 @@ | |||
111 | .Fa "const BIO *a" | 116 | .Fa "const BIO *a" |
112 | .Fc | 117 | .Fc |
113 | .Ft void | 118 | .Ft void |
119 | .Fo BIO_set_retry_read | ||
120 | .Fa "BIO *a" | ||
121 | .Fc | ||
122 | .Ft void | ||
123 | .Fo BIO_set_retry_write | ||
124 | .Fa "BIO *a" | ||
125 | .Fc | ||
126 | .Ft void | ||
127 | .Fo BIO_set_retry_special | ||
128 | .Fa "BIO *a" | ||
129 | .Fc | ||
130 | .Ft void | ||
131 | .Fo BIO_clear_retry_flags | ||
132 | .Fa "BIO *a" | ||
133 | .Fc | ||
134 | .Ft int | ||
135 | .Fo BIO_get_retry_flags | ||
136 | .Fa "BIO *a" | ||
137 | .Fc | ||
138 | .Ft void | ||
114 | .Fo BIO_set_init | 139 | .Fo BIO_set_init |
115 | .Fa "BIO *a" | 140 | .Fa "BIO *a" |
116 | .Fa "int init" | 141 | .Fa "int init" |
@@ -174,6 +199,60 @@ Application programs usually call macros like those documented in | |||
174 | rather than calling | 199 | rather than calling |
175 | .Fn BIO_test_flags | 200 | .Fn BIO_test_flags |
176 | directly. | 201 | directly. |
202 | Flag bits correspond to accessor functions as follows: | ||
203 | .Pp | ||
204 | .Bl -tag -width BIO_FLAGS_SHOULD_RETRY -compact | ||
205 | .It Dv BIO_FLAGS_READ | ||
206 | .Xr BIO_should_read 3 | ||
207 | .It Dv BIO_FLAGS_WRITE | ||
208 | .Xr BIO_should_write 3 | ||
209 | .It Dv BIO_FLAGS_IO_SPECIAL | ||
210 | .Xr BIO_should_io_special 3 | ||
211 | .It Dv BIO_FLAGS_RWS | ||
212 | .Xr BIO_retry_type 3 | ||
213 | .It Dv BIO_FLAGS_SHOULD_RETRY | ||
214 | .Xr BIO_should_retry 3 | ||
215 | .It Dv BIO_FLAGS_BASE64_NO_NL | ||
216 | see | ||
217 | .Xr BIO_f_base64 3 | ||
218 | .It Dv BIO_FLAGS_MEM_RDONLY | ||
219 | see | ||
220 | .Xr BIO_s_mem 3 | ||
221 | .El | ||
222 | .Pp | ||
223 | In particular, | ||
224 | .Dv BIO_FLAGS_RWS | ||
225 | is the bitwise OR of | ||
226 | .Dv BIO_FLAGS_READ , | ||
227 | .Dv BIO_FLAGS_WRITE , | ||
228 | and | ||
229 | .Dv BIO_FLAGS_IO_SPECIAL . | ||
230 | .Pp | ||
231 | .Fn BIO_set_retry_read , | ||
232 | .Fn BIO_set_retry_write , | ||
233 | and | ||
234 | .Fn BIO_set_retry_special | ||
235 | set the | ||
236 | .Dv BIO_FLAGS_READ , | ||
237 | .Dv BIO_FLAGS_WRITE , | ||
238 | and | ||
239 | .Dv BIO_FLAGS_IO_SPECIAL | ||
240 | flag bit in | ||
241 | .Fa b , | ||
242 | respectively. | ||
243 | They all set the | ||
244 | .Dv BIO_FLAGS_SHOULD_RETRY | ||
245 | flag bit, too. | ||
246 | .Pp | ||
247 | .Fn BIO_clear_retry_flags | ||
248 | clears the flag bits | ||
249 | .Dv BIO_FLAGS_READ , | ||
250 | .Dv BIO_FLAGS_WRITE , | ||
251 | .Dv BIO_FLAGS_IO_SPECIAL , | ||
252 | and | ||
253 | .Dv BIO_FLAGS_SHOULD_RETRY | ||
254 | in | ||
255 | .Fa b . | ||
177 | .Pp | 256 | .Pp |
178 | The | 257 | The |
179 | .Fn BIO_set_init | 258 | .Fn BIO_set_init |
@@ -223,7 +302,7 @@ or | |||
223 | if none is set. | 302 | if none is set. |
224 | .Pp | 303 | .Pp |
225 | .Fn BIO_test_flags | 304 | .Fn BIO_test_flags |
226 | returns the bitwise OR of the | 305 | returns the bitwise AND of the |
227 | .Fa flags | 306 | .Fa flags |
228 | argument and the flags stored in | 307 | argument and the flags stored in |
229 | .Fa a . | 308 | .Fa a . |
@@ -236,6 +315,12 @@ is set. | |||
236 | returns all the flags currently stored in | 315 | returns all the flags currently stored in |
237 | .Fa a . | 316 | .Fa a . |
238 | .Pp | 317 | .Pp |
318 | .Fn BIO_get_retry_flags | ||
319 | returns the bitwise AND of | ||
320 | .Pq Dv BIO_FLAGS_RWS | BIO_FLAGS_SHOULD_RETRY | ||
321 | and the flags stored in | ||
322 | .Fa a . | ||
323 | .Pp | ||
239 | .Fn BIO_get_init | 324 | .Fn BIO_get_init |
240 | returns the value of the init flag of | 325 | returns the value of the init flag of |
241 | .Fa a . | 326 | .Fa a . |
@@ -251,9 +336,14 @@ or with | |||
251 | .Xr BIO_set_close 3 , | 336 | .Xr BIO_set_close 3 , |
252 | .Xr BIO_should_retry 3 | 337 | .Xr BIO_should_retry 3 |
253 | .Sh HISTORY | 338 | .Sh HISTORY |
254 | .Fn BIO_set_flags | 339 | .Fn BIO_set_flags , |
340 | .Fn BIO_clear_flags , | ||
341 | .Fn BIO_set_retry_read , | ||
342 | .Fn BIO_set_retry_write , | ||
343 | .Fn BIO_set_retry_special , | ||
344 | .Fn BIO_clear_retry_flags , | ||
255 | and | 345 | and |
256 | .Fn BIO_clear_flags | 346 | .Fn BIO_get_retry_flags |
257 | first appeared in SSLeay 0.8.0 and | 347 | first appeared in SSLeay 0.8.0 and |
258 | .Fn BIO_get_flags | 348 | .Fn BIO_get_flags |
259 | in SSLeay 0.9.0. | 349 | in SSLeay 0.9.0. |