diff options
| -rw-r--r-- | docs/man/nng_tcp_dialer_close.3tcp.adoc | 5 | ||||
| -rw-r--r-- | docs/man/nng_tcp_dialer_free.3tcp.adoc | 3 | ||||
| -rw-r--r-- | docs/man/nng_tcp_listener.5.adoc | 6 | ||||
| -rw-r--r-- | docs/man/nng_tcp_listener_accept.3tcp.adoc | 5 | ||||
| -rw-r--r-- | docs/man/nng_tcp_listener_close.3tcp.adoc | 7 | ||||
| -rw-r--r-- | docs/man/nng_tcp_listener_free.3tcp.adoc | 3 | ||||
| -rw-r--r-- | docs/man/nng_tcp_listener_setopt.3tcp.adoc | 1 | ||||
| -rw-r--r-- | docs/man/nng_tcp_setopt.3tcp.adoc | 2 |
8 files changed, 13 insertions, 19 deletions
diff --git a/docs/man/nng_tcp_dialer_close.3tcp.adoc b/docs/man/nng_tcp_dialer_close.3tcp.adoc index 94b720d5..b325a3a0 100644 --- a/docs/man/nng_tcp_dialer_close.3tcp.adoc +++ b/docs/man/nng_tcp_dialer_close.3tcp.adoc @@ -28,8 +28,7 @@ void nng_tcp_dialer_close(nng_tcp_dialer *d); The `nng_tcp_dialer_close()` function closes the supplied TCP dialer _d_, but does not free the underlying resources associated with it. -If any dial operations -(see `<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial()>>`) using _d_ are +If any <<nng_tcp_dialer_dial.3tcp#,dial>> operations using _d_ are in progress, they will be terminated with an `NNG_ECLOSED` error condition. Furthermore any future accesses to the dialer _d_ will also result in @@ -37,7 +36,7 @@ Furthermore any future accesses to the dialer _d_ will also result in NOTE: This function does not release the memory for the dialer, so the application should still free the memory using -`<<nng_tcp_dialer_free.3tcp#,nng_tcp_dialer_free(3tcp)>>` +<<nng_tcp_dialer_free.3tcp#,`nng_tcp_dialer_free()`>> once it is certain that nothing else is using it. == RETURN VALUES diff --git a/docs/man/nng_tcp_dialer_free.3tcp.adoc b/docs/man/nng_tcp_dialer_free.3tcp.adoc index 3116ad8e..7b15fc39 100644 --- a/docs/man/nng_tcp_dialer_free.3tcp.adoc +++ b/docs/man/nng_tcp_dialer_free.3tcp.adoc @@ -28,8 +28,7 @@ void nng_tcp_dialer_free(nng_tcp_dialer *d); The `nng_tcp_dialer_free()` function closes the supplied TCP dialer _d_, and frees the underlying resources associated with it. -If any dial operations -(see `<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial()>>`) using _d_ are +If any <<nng_tcp_dialer_dial.3tcp#,dial>> operations using _d_ are in progress, they will be terminated with an `NNG_ECLOSED` error condition. WARNING: It is important that the application ensure that no further accesses diff --git a/docs/man/nng_tcp_listener.5.adoc b/docs/man/nng_tcp_listener.5.adoc index 851ff2fa..f616d321 100644 --- a/docs/man/nng_tcp_listener.5.adoc +++ b/docs/man/nng_tcp_listener.5.adoc @@ -1,6 +1,6 @@ = nng_tcp_listener(5) // -// 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,7 +27,7 @@ typedef struct nng_tcp_dialer_s nng_tcp_dialer; (((TCP, listener))) An `nng_tcp_listener` is a handle to a TCP "`listener`", which is responsible -for accepting connections (`<<nng_tcp.5#,nng_tcp>>` objects) from remote +for accepting connections (<<nng_tcp.5#,`nng_tcp`>> objects) from remote systems. NOTE: The `nng_tcp_listener` object is used for raw TCP connections, and @@ -35,7 +35,7 @@ should not be confused with a listener object created using the <<nng_tcp.7#,nng_tcp(7)>> transport. TIP: Most NNG applications should not use this, but instead use the -`<<nng_tcp.7#,nng_tcp>>` transport instead. +<<nng_tcp.7#,nng_tcp(7)>> transport instead. == SEE ALSO diff --git a/docs/man/nng_tcp_listener_accept.3tcp.adoc b/docs/man/nng_tcp_listener_accept.3tcp.adoc index b7391851..e0c5f27b 100644 --- a/docs/man/nng_tcp_listener_accept.3tcp.adoc +++ b/docs/man/nng_tcp_listener_accept.3tcp.adoc @@ -30,8 +30,7 @@ from a remote peer, using the listener _l_. The operation is completed asynchronously, using _aio_. This operation can only be done after the listener is already bound to -a TCP port and is listening. -(See `<<nng_tcp_listener_listen.3tcp#,nng_tcp_listener_listen()>>`.) +a TCP port and is <<nng_tcp_listener_listen.3tcp#,listening>>. If a connection is successfully established, the _aio_ will have the resulting `<<nng_tcp.5#,nng_tcp>>` stored as its first output. @@ -50,7 +49,7 @@ None. [horizontal] `NNG_ECANCELED`:: The operation was aborted. -`NNG_ECLOSED`:: The dialer is closed. +`NNG_ECLOSED`:: The listener is closed. `NNG_ECONNRESET`:: The TCP connection was reset by the peer. `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ESTATE`:: The listener is not not listening. diff --git a/docs/man/nng_tcp_listener_close.3tcp.adoc b/docs/man/nng_tcp_listener_close.3tcp.adoc index 57b7088e..a85d3675 100644 --- a/docs/man/nng_tcp_listener_close.3tcp.adoc +++ b/docs/man/nng_tcp_listener_close.3tcp.adoc @@ -1,6 +1,6 @@ = nng_tcp_listener_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 @@ -28,8 +28,7 @@ void nng_tcp_listener_close(nng_tcp_listener *l); The `nng_tcp_listener_close()` function closes the supplied TCP listener _l_, but does not free the underlying resources associated with it. -If any acceppt operations -(see `<<nng_tcp_listener_accept.3tcp#,nng_tcp_listener_accept()>>`) using _l_ +If any <<nng_tcp_listener_accept.3tcp#,accept>> operations using _l_ are in progress, they will be terminated with an `NNG_ECLOSED` error condition. Furthermore any future accesses to the listener _l_ will also result in @@ -37,7 +36,7 @@ Furthermore any future accesses to the listener _l_ will also result in NOTE: This function does not release the memory for the listener, so the application should still free the memory using -`<<nng_tcp_listener_free.3tcp#,nng_tcp_listener_free(3tcp)>>` +<<nng_tcp_listener_free.3tcp#,`nng_tcp_listener_free()`>> once it is certain that nothing else is using it. == RETURN VALUES diff --git a/docs/man/nng_tcp_listener_free.3tcp.adoc b/docs/man/nng_tcp_listener_free.3tcp.adoc index cd37935c..a91a67b4 100644 --- a/docs/man/nng_tcp_listener_free.3tcp.adoc +++ b/docs/man/nng_tcp_listener_free.3tcp.adoc @@ -28,8 +28,7 @@ void nng_tcp_listener_free(nng_tcp_listener *l); The `nng_tcp_listener_free()` function closes the supplied TCP listener _l_, and frees the underlying resources associated with it. -If any accept operations -(see `<<nng_tcp_listener_accept.3tcp#,nng_tcp_listener_accept()>>`) using _l_ +If any <<nng_tcp_listener_accept.3tcp#,accept>> operations using _l_ are in progress, they will be terminated with an `NNG_ECLOSED` error condition. WARNING: It is important that the application ensure that no further accesses diff --git a/docs/man/nng_tcp_listener_setopt.3tcp.adoc b/docs/man/nng_tcp_listener_setopt.3tcp.adoc index 4cf1297a..15aa4e1f 100644 --- a/docs/man/nng_tcp_listener_setopt.3tcp.adoc +++ b/docs/man/nng_tcp_listener_setopt.3tcp.adoc @@ -35,7 +35,6 @@ in length. The options specifically suppported for modification on TCP listeners are: -* <<nng_options.5#NNG_OPT_TCP_LOCADDR,`NNG_OPT_LOCADDR`>> * <<nng_options.5#NNG_OPT_TCP_KEEPALIVE,`NNG_OPT_TCP_KEEPALIVE`>> * <<nng_options.5#NNG_OPT_TCP_NODELAY,`NNG_OPT_TCP_NODELAY`>> diff --git a/docs/man/nng_tcp_setopt.3tcp.adoc b/docs/man/nng_tcp_setopt.3tcp.adoc index 35b6597c..9debd3ef 100644 --- a/docs/man/nng_tcp_setopt.3tcp.adoc +++ b/docs/man/nng_tcp_setopt.3tcp.adoc @@ -27,7 +27,7 @@ int nng_tcp_setopt(nng_tcp *conn, const char *name, const void *data, size_t siz == DESCRIPTION The `nng_tcp_setopt()` is used to set the option _name_ for the -<<nng_tcp5.#,TCP connection>> _conn_. +<<nng_tcp.5#,TCP connection>> _conn_. The value to set is copied from _data_, which should be _size_ bytes in length. |