diff options
Diffstat (limited to 'src/lib/libcrypto/man/BIO_s_bio.3')
-rw-r--r-- | src/lib/libcrypto/man/BIO_s_bio.3 | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/src/lib/libcrypto/man/BIO_s_bio.3 b/src/lib/libcrypto/man/BIO_s_bio.3 index c7d602990e..ccd3bf8ef9 100644 --- a/src/lib/libcrypto/man/BIO_s_bio.3 +++ b/src/lib/libcrypto/man/BIO_s_bio.3 | |||
@@ -1,6 +1,6 @@ | |||
1 | .\" $OpenBSD: BIO_s_bio.3,v 1.4 2016/11/06 15:52:50 jmc Exp $ | 1 | .\" $OpenBSD: BIO_s_bio.3,v 1.5 2016/11/07 15:52:47 jmc Exp $ |
2 | .\" | 2 | .\" |
3 | .Dd $Mdocdate: November 6 2016 $ | 3 | .Dd $Mdocdate: November 7 2016 $ |
4 | .Dt BIO_S_BIO 3 | 4 | .Dt BIO_S_BIO 3 |
5 | .Os | 5 | .Os |
6 | .Sh NAME | 6 | .Sh NAME |
@@ -79,7 +79,7 @@ have all the data processed by the chain under application control. | |||
79 | .Pp | 79 | .Pp |
80 | One typical use of BIO pairs is | 80 | One typical use of BIO pairs is |
81 | to place TLS/SSL I/O under application control. | 81 | to place TLS/SSL I/O under application control. |
82 | This can be used when the application wishes to use a non standard | 82 | This can be used when the application wishes to use a non-standard |
83 | transport for TLS/SSL or the normal socket routines are inappropriate. | 83 | transport for TLS/SSL or the normal socket routines are inappropriate. |
84 | .Pp | 84 | .Pp |
85 | Calls to | 85 | Calls to |
@@ -147,7 +147,7 @@ does not check whether | |||
147 | .Fa bio1 | 147 | .Fa bio1 |
148 | or | 148 | or |
149 | .Fa bio2 | 149 | .Fa bio2 |
150 | do point to some other BIO, the values are overwritten, | 150 | point to some other BIO; the values are overwritten and |
151 | .Xr BIO_free 3 | 151 | .Xr BIO_free 3 |
152 | is not called. | 152 | is not called. |
153 | .Pp | 153 | .Pp |
@@ -186,19 +186,7 @@ never returns an amount larger than that returned by | |||
186 | can also be used to reset the value returned by | 186 | can also be used to reset the value returned by |
187 | .Fn BIO_get_read_request | 187 | .Fn BIO_get_read_request |
188 | to zero. | 188 | to zero. |
189 | .Sh RETURN VALUES | 189 | .Pp |
190 | .Fn BIO_new_bio_pair | ||
191 | returns 1 on success, with the new BIOs available in | ||
192 | .Fa bio1 | ||
193 | and | ||
194 | .Fa bio2 , | ||
195 | or 0 on failure, with NULL pointers stored into the locations for | ||
196 | .Fa bio1 | ||
197 | and | ||
198 | .Fa bio2 . | ||
199 | Check the error stack for more information. | ||
200 | .\" XXX More return values need to be added here. | ||
201 | .Sh NOTES | ||
202 | Both halves of a BIO pair should be freed. | 190 | Both halves of a BIO pair should be freed. |
203 | Even if one half is implicitly freed due to a | 191 | Even if one half is implicitly freed due to a |
204 | .Xr BIO_free_all 3 | 192 | .Xr BIO_free_all 3 |
@@ -233,12 +221,24 @@ will be true. | |||
233 | If the application then waits for data to become available | 221 | If the application then waits for data to become available |
234 | on the underlying transport before flushing the write buffer, | 222 | on the underlying transport before flushing the write buffer, |
235 | it will never succeed because the request was never sent. | 223 | it will never succeed because the request was never sent. |
224 | .Sh RETURN VALUES | ||
225 | .Fn BIO_new_bio_pair | ||
226 | returns 1 on success, with the new BIOs available in | ||
227 | .Fa bio1 | ||
228 | and | ||
229 | .Fa bio2 , | ||
230 | or 0 on failure, with NULL pointers stored into the locations for | ||
231 | .Fa bio1 | ||
232 | and | ||
233 | .Fa bio2 . | ||
234 | Check the error stack for more information. | ||
235 | .\" XXX More return values need to be added here. | ||
236 | .Sh EXAMPLES | 236 | .Sh EXAMPLES |
237 | The BIO pair can be used to have full control | 237 | The BIO pair can be used to have full control |
238 | over the network access of an application. | 238 | over the network access of an application. |
239 | The application can call | 239 | The application can call |
240 | .Xr select 2 | 240 | .Xr select 2 |
241 | on the socket as required without having to go through the SSL-interface. | 241 | on the socket as required without having to go through the SSL interface. |
242 | .Bd -literal -offset 2n | 242 | .Bd -literal -offset 2n |
243 | BIO *internal_bio, *network_bio; | 243 | BIO *internal_bio, *network_bio; |
244 | \&... | 244 | \&... |