diff options
author | jsing <> | 2015-04-02 05:53:08 +0000 |
---|---|---|
committer | jsing <> | 2015-04-02 05:53:08 +0000 |
commit | 97bb1199259f59ad5caa1a4ea71cb9917917ffec (patch) | |
tree | d0475c4279ab4a29ed3f075bd2da03af0299d33b /src/lib | |
parent | fa42f2da9a67c366dcb0813f07c19694c1d7dafd (diff) | |
download | openbsd-97bb1199259f59ad5caa1a4ea71cb9917917ffec.tar.gz openbsd-97bb1199259f59ad5caa1a4ea71cb9917917ffec.tar.bz2 openbsd-97bb1199259f59ad5caa1a4ea71cb9917917ffec.zip |
Document the fact that the tls_accept_*() functions can return
TLS_READ_AGAIN and TLS_WRITE_AGAIN.
Based on a diff from Tim van der Molen.
Diffstat (limited to 'src/lib')
-rw-r--r-- | src/lib/libtls/tls_init.3 | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/src/lib/libtls/tls_init.3 b/src/lib/libtls/tls_init.3 index f038f9313a..ac7503f6be 100644 --- a/src/lib/libtls/tls_init.3 +++ b/src/lib/libtls/tls_init.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: tls_init.3,v 1.19 2015/03/31 14:03:38 jsing Exp $ | 1 | .\" $OpenBSD: tls_init.3,v 1.20 2015/04/02 05:53:08 jsing Exp $ |
2 | .\" | 2 | .\" |
3 | .\" Copyright (c) 2014 Ted Unangst <tedu@openbsd.org> | 3 | .\" Copyright (c) 2014 Ted Unangst <tedu@openbsd.org> |
4 | .\" | 4 | .\" |
@@ -14,7 +14,7 @@ | |||
14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
16 | .\" | 16 | .\" |
17 | .Dd $Mdocdate: March 31 2015 $ | 17 | .Dd $Mdocdate: April 2 2015 $ |
18 | .Dt TLS 3 | 18 | .Dt TLS 3 |
19 | .Os | 19 | .Os |
20 | .Sh NAME | 20 | .Sh NAME |
@@ -410,9 +410,11 @@ The | |||
410 | .Fn tls_read | 410 | .Fn tls_read |
411 | and | 411 | and |
412 | .Fn tls_write | 412 | .Fn tls_write |
413 | functions and the | 413 | functions, along with the |
414 | .Fn tls_accept | ||
415 | and | ||
414 | .Fn tls_connect | 416 | .Fn tls_connect |
415 | family of functions have two special return values. | 417 | function families, have two special return values: |
416 | .Pp | 418 | .Pp |
417 | .Bl -tag -width "TLS_WRITE_AGAIN" -offset indent -compact | 419 | .Bl -tag -width "TLS_WRITE_AGAIN" -offset indent -compact |
418 | .It Dv TLS_READ_AGAIN | 420 | .It Dv TLS_READ_AGAIN |
@@ -421,9 +423,11 @@ A read operation is necessary to continue. | |||
421 | A write operation is necessary to continue. | 423 | A write operation is necessary to continue. |
422 | .El | 424 | .El |
423 | .Pp | 425 | .Pp |
424 | The caller should call the appropriate function, or in the case of | 426 | The caller should call the appropriate function, or in the case of the |
425 | .Fn tls_connect , | 427 | .Fn tls_accept |
426 | repeat the call. | 428 | or |
429 | .Fn tls_connect | ||
430 | function families, repeat the call. | ||
427 | .Sh ERRORS | 431 | .Sh ERRORS |
428 | The | 432 | The |
429 | .Fn tls_error | 433 | .Fn tls_error |