diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-01-07 23:14:51 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-01-14 20:25:40 -0800 |
| commit | d0a26bbd1caf3de2132855d7936fed8ac1f1488c (patch) | |
| tree | 5133c92dbb88df393df670555613d2f4e1a9018a /docs/man/nng_tcp_close.3tcp.adoc | |
| parent | 099d89877aca6a7236254e39d9c9f5c46083cee7 (diff) | |
| download | nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.tar.gz nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.tar.bz2 nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.zip | |
fixes #858 Document the TLS public API
This also includes a number of the documentation improvements.
The options document has been broken up into separate pages for
each of the transport specific options. We have made various
other minor improvements, fixes to markup, and cross-references.
Diffstat (limited to 'docs/man/nng_tcp_close.3tcp.adoc')
| -rw-r--r-- | docs/man/nng_tcp_close.3tcp.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/man/nng_tcp_close.3tcp.adoc b/docs/man/nng_tcp_close.3tcp.adoc index 6428501c..5e68398b 100644 --- a/docs/man/nng_tcp_close.3tcp.adoc +++ b/docs/man/nng_tcp_close.3tcp.adoc @@ -1,6 +1,6 @@ = nng_tcp_close(3tcp) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // // This document is supplied under the terms of the MIT License, a @@ -27,8 +27,8 @@ void nng_tcp_close(nng_tcp *conn); The `nng_tcp_close()` function closes the supplied TCP connection, _conn_. -If any operations are pending (such as `<<nng_tcp_send.3tcp#,nng_tcp_send()>>` -or `<<nng_tcp_recv.3tcp#,nng_tcp_recv()>>` they will be terminated with +If any operations are pending (such as <<nng_tcp_send.3tcp#,`nng_tcp_send()`>> +or <<nng_tcp_recv.3tcp#,`nng_tcp_recv()`>> they will be terminated with an `NNG_ECLOSED` error condition. Also, any new operations will fail with `NNG_ECLOSED` after the connection is closed. @@ -40,7 +40,7 @@ have completely transmitted. NOTE: Closing the connection does not free the resources associated with it. Once it is certain that no more operations are pending on the connection, -it should be freed with `<<nng_tcp_free.3tcp#,nng_tcp_free()>>`. +it should be freed with <<nng_tcp_free.3tcp#,`nng_tcp_free()`>>. == RETURN VALUES |