From e892f2e13786af2ffec74934ac363e3a9890f7b7 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Wed, 7 Mar 2018 23:53:10 -0800 Subject: Fix a number of broken links. There are still some busted links that have to be fixed, but these are the ones that are just typos or trivially fixed. There is of course some content still missing. --- docs/man/libnng.adoc | 4 +-- docs/man/nng_aio_cancel.adoc | 2 +- docs/man/nng_http_conn_close.adoc | 2 +- docs/man/nng_http_conn_read.adoc | 4 +-- docs/man/nng_http_conn_read_all.adoc | 3 +- docs/man/nng_http_conn_read_req.adoc | 3 +- docs/man/nng_http_conn_read_res.adoc | 3 +- docs/man/nng_http_conn_write.adoc | 4 +-- docs/man/nng_http_conn_write_all.adoc | 3 +- docs/man/nng_http_conn_write_req.adoc | 7 ++-- docs/man/nng_http_conn_write_res.adoc | 7 ++-- docs/man/nng_http_hijack.adoc | 4 +-- docs/man/nng_http_res_alloc.adoc | 2 +- docs/man/nng_msg_header_insert.adoc | 2 +- docs/man/nngcat.adoc | 64 +++++++++++++++++++---------------- 15 files changed, 56 insertions(+), 58 deletions(-) (limited to 'docs') diff --git a/docs/man/libnng.adoc b/docs/man/libnng.adoc index 3be2e86b..0e9761c2 100644 --- a/docs/man/libnng.adoc +++ b/docs/man/libnng.adoc @@ -114,7 +114,7 @@ mode may need to access the header of messages. === Asynchronous Operations Most applications will interact with _nng_ synchronously; that is that -functions such as <> will block the calling +functions such as <> will block the calling thread until the operation has completed. NOTE: Synchronous operations which send messages may return before the @@ -297,7 +297,7 @@ NOTE: These functions will only be present if the library has been built with TLS support. |=== -|<>|allocate TLS configuration +|<>|allocate TLS configuration |<>|set authentication mode |<>|set certificate authority chain |<>|load certificate authority from file diff --git a/docs/man/nng_aio_cancel.adoc b/docs/man/nng_aio_cancel.adoc index 22ef0166..98eb682a 100644 --- a/docs/man/nng_aio_cancel.adoc +++ b/docs/man/nng_aio_cancel.adoc @@ -36,7 +36,7 @@ If no operation is currently in progress (either because it has already finished, or no operation has been started yet), then this function has no effect. -NOTE: This function is the same as calling <> +NOTE: This function is the same as calling <> with the error `NNG_ECANCELED`. == RETURN VALUES diff --git a/docs/man/nng_http_conn_close.adoc b/docs/man/nng_http_conn_close.adoc index 0c512815..38de10f0 100644 --- a/docs/man/nng_http_conn_close.adoc +++ b/docs/man/nng_http_conn_close.adoc @@ -41,6 +41,6 @@ None. == SEE ALSO <>, -<>, +<>, <>, <> diff --git a/docs/man/nng_http_conn_read.adoc b/docs/man/nng_http_conn_read.adoc index 92826682..14d5e1af 100644 --- a/docs/man/nng_http_conn_read.adoc +++ b/docs/man/nng_http_conn_read.adoc @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been @@ -66,7 +66,7 @@ None. <>, <>, <>, -<>, +<>, <>, <>, <>, diff --git a/docs/man/nng_http_conn_read_all.adoc b/docs/man/nng_http_conn_read_all.adoc index e5f89389..f98eedd5 100644 --- a/docs/man/nng_http_conn_read_all.adoc +++ b/docs/man/nng_http_conn_read_all.adoc @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. The I/O operation completes only when the entire amount of data @@ -69,7 +69,6 @@ None. <>, <>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nng_http_conn_read_req.adoc b/docs/man/nng_http_conn_read_req.adoc index bf1c1289..d12c736b 100644 --- a/docs/man/nng_http_conn_read_req.adoc +++ b/docs/man/nng_http_conn_read_req.adoc @@ -37,7 +37,7 @@ data, based on the details of the request itself. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. == RETURN VALUES @@ -57,7 +57,6 @@ None. <>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nng_http_conn_read_res.adoc b/docs/man/nng_http_conn_read_res.adoc index 4a1f6aaa..611d194c 100644 --- a/docs/man/nng_http_conn_read_res.adoc +++ b/docs/man/nng_http_conn_read_res.adoc @@ -37,7 +37,7 @@ data, based on the details of the response itself. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. == RETURN VALUES @@ -57,7 +57,6 @@ None. <>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nng_http_conn_write.adoc b/docs/man/nng_http_conn_write.adoc index df9be033..85df3ed9 100644 --- a/docs/man/nng_http_conn_write.adoc +++ b/docs/man/nng_http_conn_write.adoc @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been @@ -67,8 +67,8 @@ None. <>, <>, <>, -<>, <>, <>, +<>, <>, <> diff --git a/docs/man/nng_http_conn_write_all.adoc b/docs/man/nng_http_conn_write_all.adoc index 3f112540..df75be71 100644 --- a/docs/man/nng_http_conn_write_all.adoc +++ b/docs/man/nng_http_conn_write_all.adoc @@ -34,7 +34,7 @@ called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. The I/O operation completes only when the entire amount of data @@ -81,7 +81,6 @@ None. <>, <>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nng_http_conn_write_req.adoc b/docs/man/nng_http_conn_write_req.adoc index 040764ca..e47dd254 100644 --- a/docs/man/nng_http_conn_write_req.adoc +++ b/docs/man/nng_http_conn_write_req.adoc @@ -30,12 +30,12 @@ The `nng_http_conn_write_req()` function starts an asynchronous write of the HTTP request _req_ to the connection _conn_. The entire request is sent, including headers, and if present, the request body data. (The request body can be set with -<> or -<>.) +<> or +<>.) This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. == RETURN VALUES @@ -55,7 +55,6 @@ None. <>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nng_http_conn_write_res.adoc b/docs/man/nng_http_conn_write_res.adoc index f2df3c72..72fc89ec 100644 --- a/docs/man/nng_http_conn_write_res.adoc +++ b/docs/man/nng_http_conn_write_res.adoc @@ -30,12 +30,12 @@ The `nng_http_conn_write_res()` function starts an asynchronous write of the HTTP response _res_ to the connection _conn_. The entire response is sent, including headers, and if present, the response body data. (The response body can be set with -<> or -<>.) +<> or +<>.) This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via <>. That result will +obtained via <>. That result will either be zero or an error code. === Persistent Connections @@ -64,7 +64,6 @@ None. <>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nng_http_hijack.adoc b/docs/man/nng_http_hijack.adoc index 8a08751f..ef1c5b73 100644 --- a/docs/man/nng_http_hijack.adoc +++ b/docs/man/nng_http_hijack.adoc @@ -33,7 +33,7 @@ WebSocket), where the underlying HTTP connection will be taken over for some other purpose, and should not be used any further by the server. This function is most useful when called from a handler function. -(See <>, <>, +<>, <>, <> diff --git a/docs/man/nng_http_res_alloc.adoc b/docs/man/nng_http_res_alloc.adoc index 9de3d012..1f4520aa 100644 --- a/docs/man/nng_http_res_alloc.adoc +++ b/docs/man/nng_http_res_alloc.adoc @@ -47,7 +47,7 @@ This function returns 0 on success, and non-zero otherwise. <>, <>, <>, -<>, +<>, <>, <>, <>, diff --git a/docs/man/nng_msg_header_insert.adoc b/docs/man/nng_msg_header_insert.adoc index 4cc5016c..e70dede7 100644 --- a/docs/man/nng_msg_header_insert.adoc +++ b/docs/man/nng_msg_header_insert.adoc @@ -42,8 +42,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO <>, +<>, <>, -<>, <>, <>, <>, diff --git a/docs/man/nngcat.adoc b/docs/man/nngcat.adoc index 5e776e95..edb22629 100644 --- a/docs/man/nngcat.adoc +++ b/docs/man/nngcat.adoc @@ -52,11 +52,12 @@ equa *--compat*:: Compatible mode. This cause _nngcat_ to behave more like the legacy _nanocat_ application. In this mode connections are made asynchronously, - and the *--pair* option selects version 0 of the <> protocol - instead of version 1. + and the *--pair* option selects version 0 of the <> + protocol instead of version 1. *--subscribe*=_TOPIC_:: Subscribe to _TOPIC_. This option can only be used with the - <> protocol. The _TOPIC_ is checked against the first bytes + <> protocol. The _TOPIC_ is checked against the + first bytes of messages received, and messages are discarded if they do not match. This may be specified multiple times to subscribe to multiple topics. If not specified at all, then a default subscription to everything is assumed. @@ -65,42 +66,45 @@ equa NOTE: At least one protocol must be selected. *--bus, --bus0*:: - Select the <> protocol. This protocol can send - and receive messages to and from other <> peers. + Select the <> version 0 protocol. This protocol can send + and receive messages to and from other BUS version 0 peers. *--req, --req0*:: - Select the <> protocol. This protocol sends - messages to <> peers and receives replies from them. + Select the <> version 0 protocol. This protocol sends + messages to <> version 0 peers and receives replies + from them. *--rep, --rep0*:: - Select the <> protocol. This protocol receives - messages from <> peers and can send replies to them. + Select the <> version 0 protocol. This protocol + receives messages from <> version 0 peers and can send + replies to them. *--pub, --pub0*:: - Select the <> protocol. This protocol sends - messages to <> peers. + Select the <> version 0 protocol. This protocol sends + messages to <> version peers. *--sub, --sub0*:: - Select the <> protocol. This protocol receives - messages from <> peers, and filters them based on - subscriptions set with *--subscribe*. + Select the <> version 0 protocol. + This protocol receives messages from <> version 0 peers, + and filters them based on subscriptions set with *--subscribe*. *--push, --push0*:: - Select the <> protocol. This protocol sends - messages to <> peers. A given message is normally - only delivered to a single peer. + Select the <> version 0 protocol. + This protocol sends messages to <> version 0 peers. + A given message is normally only delivered to a single peer. *--pull, --pull0*:: - Select the <> protocol. This protocol receives - messages from <> peers. + Select the <> version 0 protocol. + This protocol receives + messages from <> version 0 peers. *--pair0*:: - Select the <> protocol. This protocol can send and - receive messages with one connected <> peer. + Select the <> veresion 0 protocol. This protocol + can send and receive messages with one connected PAIR version 0 peer. *--pair1*:: - Select the <> protocol. This protocol can send and - receive messages with one connected <> peer. It + Select the <> version 1 protocol. This protocol + can send and receive messages with one connected PAIR version 1 peer. It is not supported in *--compat* mode. (Polyamorous mode is not supported in _nngcat_, although peers may be using polyamorous mode.) @@ -109,14 +113,14 @@ NOTE: At least one protocol must be selected. which case it acts as an alias for *--pair0*. *--surveyor, --surveyor0*:: - Select the <> protocol. This protocol sends - a survey request to <> peers, and then - receives replies from them. + Select the <> version 0 protocol. + This protocol sends a survey request to <> + version 0 peers, and then receives replies from them. *--respondent, --respondent0*:: - Select the <> protocol. This protocol receives - survey requests from <> peers, and can send a reply - to them. + Select the <> version 0 protocol. + This protocol receives survey requests from <> + version 0 peers, and can send a reply to them. === Peer Selection NOTE: At least one peer address must be selected. @@ -266,7 +270,7 @@ $ nngcat --sub --dial=${addr} --quoted & == SEE ALSO <>, -<>, +<>, <>, <>, <>, -- cgit v1.2.3-70-g09d2