diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
243 files changed, 493 insertions, 128 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index d7346b13..95b270a9 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -368,5 +368,6 @@ with TLS support. == SEE ALSO +[.text-left] <<nng_compat.3compat#,nng_compat(3compat)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nn_allocmsg.3compat.adoc b/docs/man/nn_allocmsg.3compat.adoc index 943ecf4b..50e0d9cf 100644 --- a/docs/man/nn_allocmsg.3compat.adoc +++ b/docs/man/nn_allocmsg.3compat.adoc @@ -58,6 +58,7 @@ on failure. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_freemsg.3compat#,nn_freemsg(3compat)>>, <<nn_reallocmsg.3compat#,nn_reallocmsg(3compat)>>, diff --git a/docs/man/nn_bind.3compat.adoc b/docs/man/nn_bind.3compat.adoc index 42f5c58f..3095e4ca 100644 --- a/docs/man/nn_bind.3compat.adoc +++ b/docs/man/nn_bind.3compat.adoc @@ -58,6 +58,7 @@ This function returns a positive identifier on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_connect.3compat#,nn_connect(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_shutdown.3compat#,nn_shutdown(3compat)>>, diff --git a/docs/man/nn_close.3compat.adoc b/docs/man/nn_close.3compat.adoc index 40edef52..5ec13b90 100644 --- a/docs/man/nn_close.3compat.adoc +++ b/docs/man/nn_close.3compat.adoc @@ -44,6 +44,7 @@ This function returns zero on success, and -1 on failure. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_socket.3compat#,nn_socket(3compat)>>, <<nng_compat.3compat#,nng_compat(3compat)>>, diff --git a/docs/man/nn_cmsg.3compat.adoc b/docs/man/nn_cmsg.3compat.adoc index c5347a12..fd541f8e 100644 --- a/docs/man/nn_cmsg.3compat.adoc +++ b/docs/man/nn_cmsg.3compat.adoc @@ -71,6 +71,7 @@ to align for another header. == SEE ALSO +[.text-left] <<nn_recvmsg.3compat#,nn_recvmsg(3compat)>>, <<nn_sendmsg.3compat#,nn_sendmsg(3compat)>>, <<nng_compat.3compat#,nng_compat(3compat)>>, diff --git a/docs/man/nn_connect.3compat.adoc b/docs/man/nn_connect.3compat.adoc index f5002b82..a5505347 100644 --- a/docs/man/nn_connect.3compat.adoc +++ b/docs/man/nn_connect.3compat.adoc @@ -57,6 +57,7 @@ This function returns a positive identifier success, and -1 on error. == SEE ALSO +[.text-left] <<nn_bind.3compat#,nn_bind(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_shutdown.3compat#,nn_shutdown(3compat)>>, diff --git a/docs/man/nn_device.3compat.adoc b/docs/man/nn_device.3compat.adoc index 945396dc..0d123911 100644 --- a/docs/man/nn_device.3compat.adoc +++ b/docs/man/nn_device.3compat.adoc @@ -51,6 +51,7 @@ one of the sockets is closed or an error occurs. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_socket.3compat#,nn_socket(3compat)>>, <<nng_compat.3compat#,nng_compat(3compat)>>, diff --git a/docs/man/nn_errno.3compat.adoc b/docs/man/nn_errno.3compat.adoc index 316a419e..655906e9 100644 --- a/docs/man/nn_errno.3compat.adoc +++ b/docs/man/nn_errno.3compat.adoc @@ -33,7 +33,7 @@ Consider using the relevant <<libnng.3#,modern API>> instead. IMPORTANT: The error numbers returned from this function may include errors caused by system functions, which overlap the usual `errno` variable, -and this function simply returns the value of `errno`. +and this function simply returns the value of `errno`. However, the values returned may include numeric values that are not defined by the system, but are unique to _libnanomsg_, such as `EFSM`. @@ -73,6 +73,7 @@ If no operation has failed, then this will be zero. == SEE ALSO +[.text-left] <<nn_strerror.3compat#,nn_strerror(3compat)>>, <<nng_compat.3compat#,nng_compat(3compat)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nn_freemsg.3compat.adoc b/docs/man/nn_freemsg.3compat.adoc index cfdc5957..48e2ad1c 100644 --- a/docs/man/nn_freemsg.3compat.adoc +++ b/docs/man/nn_freemsg.3compat.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>, <<nn_freemsg.3compat#,nn_freemsg(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, diff --git a/docs/man/nn_get_statistic.3compat.adoc b/docs/man/nn_get_statistic.3compat.adoc index a8129f8d..c8e297e5 100644 --- a/docs/man/nn_get_statistic.3compat.adoc +++ b/docs/man/nn_get_statistic.3compat.adoc @@ -41,5 +41,6 @@ None. == SEE ALSO +[.text-left] <<nng_compat.3compat#,nng_compat(3compat)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nn_getsockopt.3compat.adoc b/docs/man/nn_getsockopt.3compat.adoc index 24e13861..75adfb58 100644 --- a/docs/man/nn_getsockopt.3compat.adoc +++ b/docs/man/nn_getsockopt.3compat.adoc @@ -114,7 +114,7 @@ explicit notification (automatic with the `NN_REQ` protocol) or allow sufficient time for the socket to drain before closing the socket or exiting. -`NN_SNDPRIO`:: +`NN_SNDPRIO`:: This option is not implemented at this time. `NN_RCVPRIO`:: @@ -219,6 +219,7 @@ This function returns zero on success, and -1 on failure. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nn_close.3compat#,nn_close(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, diff --git a/docs/man/nn_poll.3compat.adoc b/docs/man/nn_poll.3compat.adoc index a1e13992..4ca52ff2 100644 --- a/docs/man/nn_poll.3compat.adoc +++ b/docs/man/nn_poll.3compat.adoc @@ -93,6 +93,7 @@ This function returns the number of sockets with events on success, or -1 on err == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_recv.3compat#,nn_recv(3compat)>>, <<nn_send.3compat#,nn_send(3compat)>>, diff --git a/docs/man/nn_reallocmsg.3compat.adoc b/docs/man/nn_reallocmsg.3compat.adoc index c7a186ae..57d7121f 100644 --- a/docs/man/nn_reallocmsg.3compat.adoc +++ b/docs/man/nn_reallocmsg.3compat.adoc @@ -51,6 +51,7 @@ on failure. == SEE ALSO +[.text-left] <<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>, <<nn_freemsg.3compat#,nn_freemsg(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, diff --git a/docs/man/nn_recv.3compat.adoc b/docs/man/nn_recv.3compat.adoc index 8b873f8f..1b77f28f 100644 --- a/docs/man/nn_recv.3compat.adoc +++ b/docs/man/nn_recv.3compat.adoc @@ -66,6 +66,7 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_recvmsg.3compat#,nn_recvmsg(3compat)>>, <<nn_send.3compat#,nn_send(3compat)>>, diff --git a/docs/man/nn_recvmsg.3compat.adoc b/docs/man/nn_recvmsg.3compat.adoc index f9683d50..7bd2e34a 100644 --- a/docs/man/nn_recvmsg.3compat.adoc +++ b/docs/man/nn_recvmsg.3compat.adoc @@ -89,6 +89,7 @@ This function returns the number of bytes received on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_cmsg.3compat#,nn_cmsg(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_recv.3compat#,nn_recv(3compat)>>, diff --git a/docs/man/nn_send.3compat.adoc b/docs/man/nn_send.3compat.adoc index 79029b61..cb1146a5 100644 --- a/docs/man/nn_send.3compat.adoc +++ b/docs/man/nn_send.3compat.adoc @@ -65,6 +65,7 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_recv.3compat#,nn_recv(3compat)>>, <<nn_sendmsg.3compat#,nn_sendmsg(3compat)>>, diff --git a/docs/man/nn_sendmsg.3compat.adoc b/docs/man/nn_sendmsg.3compat.adoc index 71a69c14..8a3487c8 100644 --- a/docs/man/nn_sendmsg.3compat.adoc +++ b/docs/man/nn_sendmsg.3compat.adoc @@ -61,7 +61,7 @@ has the base address (`iov_base`) and length (`iov_len`) indicated. For buffers allocated for zero copy (such as by `<<nn_allocmsg.3compat#,nn_allocmsg()>>`), the value of `iov_base` should be the address of the pointer to the buffer, -rather than the address of the buffer itself. +rather than the address of the buffer itself. In this case, the value of `iov_len` should be `NN_MSG`, as the length is inferred from the allocated message. If the `msg_iovlen` field is `NN_MSG`, then this function will free @@ -97,6 +97,7 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_cmsg.3compat#,nn_cmsg(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_recv.3compat#,nn_recv(3compat)>>, diff --git a/docs/man/nn_setsockopt.3compat.adoc b/docs/man/nn_setsockopt.3compat.adoc index 7869c832..8fc5aeeb 100644 --- a/docs/man/nn_setsockopt.3compat.adoc +++ b/docs/man/nn_setsockopt.3compat.adoc @@ -108,7 +108,7 @@ Applications needing assurance of message delivery should either include an explicit notification (automatic with the `NN_REQ` protocol) or allow sufficient time for the socket to drain before closing the socket or exiting. -`NN_SNDPRIO`:: +`NN_SNDPRIO`:: This option is not implemented at this time. `NN_RCVPRIO`:: @@ -197,6 +197,7 @@ This function returns zero on success, and -1 on failure. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nn_close.3compat#,nn_close(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, diff --git a/docs/man/nn_shutdown.3compat.adoc b/docs/man/nn_shutdown.3compat.adoc index 2de6b1f0..7602ff44 100644 --- a/docs/man/nn_shutdown.3compat.adoc +++ b/docs/man/nn_shutdown.3compat.adoc @@ -46,6 +46,7 @@ This function returns zero on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_bind.3compat#,nn_bind(3compat)>>, <<nn_connect.3compat#,nn_connect(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, diff --git a/docs/man/nn_socket.3compat.adoc b/docs/man/nn_socket.3compat.adoc index 33bb1626..1cc03914 100644 --- a/docs/man/nn_socket.3compat.adoc +++ b/docs/man/nn_socket.3compat.adoc @@ -70,6 +70,7 @@ This function returns a valid socket number on success, and -1 on failure. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nn_close.3compat#,nn_close(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, diff --git a/docs/man/nn_strerror.3compat.adoc b/docs/man/nn_strerror.3compat.adoc index 090a012a..e3fd6470 100644 --- a/docs/man/nn_strerror.3compat.adoc +++ b/docs/man/nn_strerror.3compat.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nng_compat.3compat#,nng_compat(3compat)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nn_term.3compat.adoc b/docs/man/nn_term.3compat.adoc index e61a40ed..36cb7482 100644 --- a/docs/man/nn_term.3compat.adoc +++ b/docs/man/nn_term.3compat.adoc @@ -52,6 +52,7 @@ None. == SEE ALSO +[.text-left] <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_socket.3compat#,nn_socket(3compat)>>, <<nng_compat.3compat#,nng_compat(3compat)>>, diff --git a/docs/man/nng.7.adoc b/docs/man/nng.7.adoc index 425d2c0f..ab7c5687 100644 --- a/docs/man/nng.7.adoc +++ b/docs/man/nng.7.adoc @@ -51,25 +51,38 @@ other languages please check the http://nanomsg.org/[website]. == Protocols -* <<nng_bus.7#,nng_bus(7)>> - Bus protocol -* <<nng_pair.7#,nng_pair(7)>> - Pair protocol -* <<nng_pub.7#,nng_pub(7)>> - Publisher side of publish/subscribe protocol -* <<nng_pull.7#,nng_pull(7)>> - Pull side of pipeline protocol -* <<nng_push.7#,nng_push(7)>> - Push side of pipeline protocol -* <<nng_sub.7#,nng_sub(7)>> - Subscriber side of publish/subscribe protocol -* <<nng_rep.7#,nng_rep(7)>> - Reply side of request/reply protocol -* <<nng_req.7#,nng_req(7)>> - Request side of request/reply protocol -* <<nng_respondent.7#,nng_respondent(7)>> - Respondent side of survey protocol -* <<nng_surveyor.7#,nng_surveyor(7)>> - Surveyor side of survey protocol +[horizontal] +<<nng_bus.7#,nng_bus(7)>>:: Bus protocol +<<nng_pair.7#,nng_pair(7)>>:: Pair protocol +<<nng_pub.7#,nng_pub(7)>>:: Publisher side of publish/subscribe protocol +<<nng_pull.7#,nng_pull(7)>>:: Pull side of pipeline protocol +<<nng_push.7#,nng_push(7)>>:: Push side of pipeline protocol +<<nng_sub.7#,nng_sub(7)>>:: Subscriber side of publish/subscribe protocol +<<nng_rep.7#,nng_rep(7)>>:: Reply side of request/reply protocol +<<nng_req.7#,nng_req(7)>>:: Request side of request/reply protocol +<<nng_respondent.7#,nng_respondent(7)>>:: Respondent side of survey protocol +<<nng_surveyor.7#,nng_surveyor(7)>>:: Surveyor side of survey protocol + +//* <<nng_bus.7#,nng_bus(7)>> - Bus protocol +//* <<nng_pair.7#,nng_pair(7)>> - Pair protocol +//* <<nng_pub.7#,nng_pub(7)>> - Publisher side of publish/subscribe protocol +//* <<nng_pull.7#,nng_pull(7)>> - Pull side of pipeline protocol +//* <<nng_push.7#,nng_push(7)>> - Push side of pipeline protocol +//* <<nng_sub.7#,nng_sub(7)>> - Subscriber side of publish/subscribe protocol +//* <<nng_rep.7#,nng_rep(7)>> - Reply side of request/reply protocol +//* <<nng_req.7#,nng_req(7)>> - Request side of request/reply protocol +//* <<nng_respondent.7#,nng_respondent(7)>> - Respondent side of survey protocol +//* <<nng_surveyor.7#,nng_surveyor(7)>> - Surveyor side of survey protocol == Transports -* <<nng_inproc.7#,nng_inproc(7)>> - Intra-process transport -* <<nng_ipc.7#,nng_ipc(7)>> - Inter-process transport -* <<nng_tls.7#,nng_tls(7)>> - TLSv1.2 over TCP transport -* <<nng_tcp.7#,nng_tcp(7)>> - TCP (and TCPv6) transport -* <<nng_ws.7#,nng_ws(7)>> - WebSocket transport -* <<nng_zerotier.7#,nng_zerotier(7)>> - ZeroTier transport +[horizontal] +<<nng_inproc.7#,nng_inproc(7)>>:: Intra-process transport +<<nng_ipc.7#,nng_ipc(7)>>:: Inter-process transport +<<nng_tls.7#,nng_tls(7)>>:: TLSv1.2 over TCP transport +<<nng_tcp.7#,nng_tcp(7)>>:: TCP (and TCPv6) transport +<<nng_ws.7#,nng_ws(7)>>:: WebSocket transport +<<nng_zerotier.7#,nng_zerotier(7)>>:: ZeroTier transport == Conceptual Overview @@ -118,7 +131,7 @@ other than in a few specific circumstances. === Raw Mode (((cooked mode)))(((raw mode))) -Most applications will use _nng_ sockets in "`cooked`" mode. +Most applications will use _nng_ sockets in "`cooked`" mode. This mode provides the full semantics of the protocol. For example, <<nng_req.7#,_req_>> sockets will automatically match a reply to a request, and resend requests periodically if no reply @@ -144,7 +157,7 @@ processing is needed. (((URL))) The _nng_ library uses ((universal resource locators)) (URLs) -following the format specified in +following the format specified in https://tools.ietf.org/html/rfc3986[RFC 3986], including some schemes that are unique to SP. @@ -164,7 +177,7 @@ https://tools.ietf.org/html/rfc3986#section-6.2.2[RFC 3986 6.2.2]: . The resulting path is checked for invalid UTF-8 sequences, consisting of surrogate pairs, illegal byte sequences, or overlong encodings. If this check fails, then the entire URL is considered invalid. - . Path segments consisting of `.` and `..` are resolved as per + . Path segments consisting of `.` and `..` are resolved as per https://tools.ietf.org/html/rfc3986#section-6.2.2.3[RFC 3986 6.2.2.3]. . Further, empty path segments are removed, meaning that duplicate slash (`/`) separators are removed from the path. @@ -186,5 +199,6 @@ The library API is documented at <<libnng.3#,libnng(3)>>. == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng_compat.3compat#,nng_compat(3compat)>> diff --git a/docs/man/nng_aio.5.adoc b/docs/man/nng_aio.5.adoc index 292d13c1..e47fefae 100644 --- a/docs/man/nng_aio.5.adoc +++ b/docs/man/nng_aio.5.adoc @@ -49,6 +49,7 @@ and destroyed using `<<nng_aio_free.3#,nng_aio_free()>>`. == SEE ALSO +[.text-left] <<nng_aio_abort.3#,nng_aio_abort(3)>>, <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, diff --git a/docs/man/nng_aio_abort.3.adoc b/docs/man/nng_aio_abort.3.adoc index 3a68f015..d48e9973 100644 --- a/docs/man/nng_aio_abort.3.adoc +++ b/docs/man/nng_aio_abort.3.adoc @@ -47,6 +47,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_aio_alloc.3.adoc b/docs/man/nng_aio_alloc.3.adoc index 9e92dd4a..2dc6d4a8 100644 --- a/docs/man/nng_aio_alloc.3.adoc +++ b/docs/man/nng_aio_alloc.3.adoc @@ -57,10 +57,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory to perform the operation. == SEE ALSO +[.text-left] <<nng_aio_abort.3#,nng_aio_abort(3)>>, <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, <<nng_aio_count.3#,nng_aio_count(3)>>, diff --git a/docs/man/nng_aio_cancel.3.adoc b/docs/man/nng_aio_cancel.3.adoc index 51148fa1..9d646110 100644 --- a/docs/man/nng_aio_cancel.3.adoc +++ b/docs/man/nng_aio_cancel.3.adoc @@ -50,6 +50,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_abort.3#,nng_aio_abort(3)>>, <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_aio_count.3.adoc b/docs/man/nng_aio_count.3.adoc index 8050ce9a..43ca6907 100644 --- a/docs/man/nng_aio_count.3.adoc +++ b/docs/man/nng_aio_count.3.adoc @@ -25,7 +25,7 @@ size_t nng_aio_count(nng_aio *aio); == DESCRIPTION The `nng_aio_count()` returns the number of bytes transferred by the -asynchronous operation associated with the handle _aio_. +asynchronous operation associated with the handle _aio_. Some asynchronous operations do not provide meaningful data for this function; for example operations that establish connections do not @@ -51,6 +51,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, <<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>, diff --git a/docs/man/nng_aio_finish.3.adoc b/docs/man/nng_aio_finish.3.adoc index ee82ed10..00148fd6 100644 --- a/docs/man/nng_aio_finish.3.adoc +++ b/docs/man/nng_aio_finish.3.adoc @@ -50,6 +50,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_aio_free.3.adoc b/docs/man/nng_aio_free.3.adoc index 0b19f4be..da45eff2 100644 --- a/docs/man/nng_aio_free.3.adoc +++ b/docs/man/nng_aio_free.3.adoc @@ -40,6 +40,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_stop.3#,nng_aio_stop(3)>>, <<nng_aio.5#,nng_aio(5)>>, diff --git a/docs/man/nng_aio_get_input.3.adoc b/docs/man/nng_aio_get_input.3.adoc index 018f7d04..133e7ea1 100644 --- a/docs/man/nng_aio_get_input.3.adoc +++ b/docs/man/nng_aio_get_input.3.adoc @@ -44,6 +44,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_get_output.3#,nng_aio_get_output(3)>>, <<nng_aio_set_input.3#,nng_aio_set_input(3)>>, diff --git a/docs/man/nng_aio_get_msg.3.adoc b/docs/man/nng_aio_get_msg.3.adoc index d884c28b..a9e8f4b2 100644 --- a/docs/man/nng_aio_get_msg.3.adoc +++ b/docs/man/nng_aio_get_msg.3.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, <<nng_recv_aio.3#,nng_recv_aio(3)>>, <<nng_aio.5#,nng_aio(5)>>, diff --git a/docs/man/nng_aio_get_output.3.adoc b/docs/man/nng_aio_get_output.3.adoc index b829def3..862b2945 100644 --- a/docs/man/nng_aio_get_output.3.adoc +++ b/docs/man/nng_aio_get_output.3.adoc @@ -47,6 +47,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_get_output.3#,nng_aio_get_output(3)>>, <<nng_aio_set_input.3#,nng_aio_set_input(3)>>, diff --git a/docs/man/nng_aio_result.3.adoc b/docs/man/nng_aio_result.3.adoc index a793b9ad..f6c6f406 100644 --- a/docs/man/nng_aio_result.3.adoc +++ b/docs/man/nng_aio_result.3.adoc @@ -37,11 +37,12 @@ callback, or after waiting for the operation to complete with == RETURN VALUES -The result of the operation, either zero on success, or an error +The result of the operation, either zero on success, or an error number on failure. == ERRORS +[horizontal] `NNG_ETIMEDOUT`:: The operation timed out. `NNG_ECANCELED`:: The operation was canceled. @@ -49,6 +50,7 @@ Various other return values are possible dependending on the operation. == SEE ALSO +[.text-left] <<nng_aio_abort.3#,nng_aio_abort(3)>>, <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_wait.3#,nng_aio_wait(3)>>, diff --git a/docs/man/nng_aio_set_input.3.adoc b/docs/man/nng_aio_set_input.3.adoc index 696f1513..ed635249 100644 --- a/docs/man/nng_aio_set_input.3.adoc +++ b/docs/man/nng_aio_set_input.3.adoc @@ -24,7 +24,7 @@ void nng_aio_set_input(nng_aio *aio, unsigned int index, void *param); == DESCRIPTION -The `nng_aio_set_input()` function sets the input parameter at _index_ +The `nng_aio_set_input()` function sets the input parameter at _index_ to _param_ for the asynchronous operation associated with _aio_. The type and semantics of input parameters are determined by specific @@ -54,6 +54,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_get_input.3#,nng_aio_get_input(3)>>, <<nng_aio_get_output.3#,nng_aio_get_output(3)>>, diff --git a/docs/man/nng_aio_set_iov.3.adoc b/docs/man/nng_aio_set_iov.3.adoc index ed200a13..72f3fdf3 100644 --- a/docs/man/nng_aio_set_iov.3.adoc +++ b/docs/man/nng_aio_set_iov.3.adoc @@ -25,7 +25,7 @@ int nng_aio_set_iov(nng_aio *aio, unsigned int niov, nng_iov *iov); == DESCRIPTION The `nng_aio_set_iov()` function sets a ((scatter/gather)) vector _iov_ on the -handle _aio_. +handle _aio_. The _iov_ is a pointer to an array of _niov_ `<<nng_iov.5#,nng_iov>>` structures, which have the following definition: @@ -60,11 +60,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory to perform operation. `NNG_EINVAL`:: Value of specified _niov_ is too large. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, <<nng_aio_count.3#,nng_aio_count(3)>>, diff --git a/docs/man/nng_aio_set_msg.3.adoc b/docs/man/nng_aio_set_msg.3.adoc index c0147e65..13702c15 100644 --- a/docs/man/nng_aio_set_msg.3.adoc +++ b/docs/man/nng_aio_set_msg.3.adoc @@ -39,6 +39,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, <<nng_send_aio.3#,nng_send_aio(3)>>, <<nng_aio.5#,nng_aio(5)>>, diff --git a/docs/man/nng_aio_set_output.3.adoc b/docs/man/nng_aio_set_output.3.adoc index 2f753db7..2314ef90 100644 --- a/docs/man/nng_aio_set_output.3.adoc +++ b/docs/man/nng_aio_set_output.3.adoc @@ -24,7 +24,7 @@ void nng_aio_set_output(nng_aio *aio, unsigned int index, void *result); == DESCRIPTION -The `nng_aio_set_output()` function sets the output result at _index_ +The `nng_aio_set_output()` function sets the output result at _index_ to _result_ for the asynchronous operation associated with _aio_. The type and semantics of output results are determined by specific @@ -51,6 +51,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_finish.3#,nng_aio_finish(3)>>, <<nng_aio_get_output.3#,nng_aio_get_output(3)>>, diff --git a/docs/man/nng_aio_set_timeout.3.adoc b/docs/man/nng_aio_set_timeout.3.adoc index 29321504..f1a91e52 100644 --- a/docs/man/nng_aio_set_timeout.3.adoc +++ b/docs/man/nng_aio_set_timeout.3.adoc @@ -56,6 +56,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_aio_stop.3.adoc b/docs/man/nng_aio_stop.3.adoc index 12e8d1da..4dc55a51 100644 --- a/docs/man/nng_aio_stop.3.adoc +++ b/docs/man/nng_aio_stop.3.adoc @@ -54,6 +54,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_cancel.3#,nng_aio_cancel(3)>>, <<nng_aio_free.3#,nng_aio_free(3)>>, <<nng_aio_wait.3#,nng_aio_wait(3)>>, diff --git a/docs/man/nng_aio_wait.3.adoc b/docs/man/nng_aio_wait.3.adoc index 775ddfc9..ce751133 100644 --- a/docs/man/nng_aio_wait.3.adoc +++ b/docs/man/nng_aio_wait.3.adoc @@ -42,6 +42,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_abort.3#,nng_aio_abort(3)>>, <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio.5#,nng_aio(5)>>, diff --git a/docs/man/nng_alloc.3.adoc b/docs/man/nng_alloc.3.adoc index 3b6e27dd..fdde0023 100644 --- a/docs/man/nng_alloc.3.adoc +++ b/docs/man/nng_alloc.3.adoc @@ -26,7 +26,7 @@ void *nng_alloc(size_t size); The `nng_alloc()` function allocates a contiguous memory region of at least _size_ bytes. -The memory will be 64-bit aligned. +The memory will be 64-bit aligned. The returned memory can be used to hold message buffers, in which case it can be directly passed to `<<nng_send.3#,nng_send()>>` using @@ -49,6 +49,7 @@ treated the same as `NNG_ENOMEM`. == SEE ALSO +[.text-left] <<nng_free.3#,nng_free(3)>>, <<nng_send.3#,nng_send(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_bus.7.adoc b/docs/man/nng_bus.7.adoc index 98367c3d..eba870c7 100644 --- a/docs/man/nng_bus.7.adoc +++ b/docs/man/nng_bus.7.adoc @@ -79,5 +79,6 @@ When using "`cooked`" _bus_ sockets, no message headers are present. == SEE ALSO +[.text-left] <<nng_bus_open.3#,nng_bus_open(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_bus_open.3.adoc b/docs/man/nng_bus_open.3.adoc index 50369c07..072074e1 100644 --- a/docs/man/nng_bus_open.3.adoc +++ b/docs/man/nng_bus_open.3.adoc @@ -40,11 +40,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_bus.7#,nng_bus(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_clock.3supp.adoc b/docs/man/nng_clock.3supp.adoc index cfbf0bf3..18187824 100644 --- a/docs/man/nng_clock.3supp.adoc +++ b/docs/man/nng_clock.3supp.adoc @@ -50,6 +50,7 @@ None. == SEE ALSO +[.text-left] <<nng_sleep_aio.3#,nng_sleep_aio(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, <<nng_cv_until.3supp#,nng_cv_until(3supp)>>, diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc index e1753dc3..d7a5a11d 100644 --- a/docs/man/nng_close.3.adoc +++ b/docs/man/nng_close.3.adoc @@ -40,10 +40,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: The socket _s_ is already closed or was never opened. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_options.5#,nng_options(5)>>, <<nng_socket.5#,nng_socket(5)>>, diff --git a/docs/man/nng_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc index 148f09d1..05fe1383 100644 --- a/docs/man/nng_compat.3compat.adoc +++ b/docs/man/nng_compat.3compat.adoc @@ -209,5 +209,6 @@ The following caveats apply when using the legacy API with _nng_. == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_ctx.5.adoc b/docs/man/nng_ctx.5.adoc index 483a4c1f..a382f4ab 100644 --- a/docs/man/nng_ctx.5.adoc +++ b/docs/man/nng_ctx.5.adoc @@ -61,7 +61,7 @@ global behavior. Historically, applications wanting to use a stateful protocol concurrently would have to resort to <<nng.7#raw_mode,raw mode>> sockets, which bypasses much of the various protocol handling, leaving it to up to the application -to do so. +to do so. Contexts make it possible to still benefit from advanced protocol handling, including timeouts, retries, and matching requests to responses, while doing so concurrently. @@ -158,6 +158,7 @@ start_echo_service(nng_socket rep_socket) == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng_ctx_close.3#,nng_ctx_close(3)>>, <<nng_ctx_open.3#,nng_ctx_open(3)>>, diff --git a/docs/man/nng_ctx_close.3.adoc b/docs/man/nng_ctx_close.3.adoc index 32cb44f6..2ac3b946 100644 --- a/docs/man/nng_ctx_close.3.adoc +++ b/docs/man/nng_ctx_close.3.adoc @@ -43,10 +43,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: The context _ctx_ is already closed or was never opened. == SEE ALSO +[.text-left] <<nng_ctx_open.3#,nng_ctx_open(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, <<nng_ctx.5#,nng_ctx(5)>>, diff --git a/docs/man/nng_ctx_getopt.3.adoc b/docs/man/nng_ctx_getopt.3.adoc index d6a19a16..2cdfaee5 100644 --- a/docs/man/nng_ctx_getopt.3.adoc +++ b/docs/man/nng_ctx_getopt.3.adoc @@ -109,6 +109,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket. `NNG_EINVAL`:: Size of destination _val_ too small for object. @@ -118,6 +119,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_ctx_setopt.3#,nng_ctx_setopt(3)>>, <<nng_strdup.3#,nng_strdup(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_ctx_id.3.adoc b/docs/man/nng_ctx_id.3.adoc index ba79684c..93b0d02d 100644 --- a/docs/man/nng_ctx_id.3.adoc +++ b/docs/man/nng_ctx_id.3.adoc @@ -46,5 +46,6 @@ None. == SEE ALSO +[.text-left] <<nng_ctx.5#,nng_ctx(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_ctx_open.3.adoc b/docs/man/nng_ctx_open.3.adoc index 86686417..f8d5b546 100644 --- a/docs/man/nng_ctx_open.3.adoc +++ b/docs/man/nng_ctx_open.3.adoc @@ -51,11 +51,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol does not support separate contexts, or the socket was opened in raw mode. == SEE ALSO +[.text-left] <<nng_ctx_close.3#,nng_ctx_close(3)>>, <<nng_ctx_getopt.3#,nng_ctx_getopt(3)>>, <<nng_ctx_recv.3#,nng_ctx_recv(3)>>, diff --git a/docs/man/nng_ctx_recv.3.adoc b/docs/man/nng_ctx_recv.3.adoc index 03aa5de8..81e4de30 100644 --- a/docs/man/nng_ctx_recv.3.adoc +++ b/docs/man/nng_ctx_recv.3.adoc @@ -53,6 +53,7 @@ None. (The operation completes asynchronously.) == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was aborted. `NNG_ECLOSED`:: The context _ctx_ is not open. `NNG_ENOMEM`:: Insufficient memory is available. @@ -62,6 +63,7 @@ None. (The operation completes asynchronously.) == SEE ALSO +[.text-left] <<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, <<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, diff --git a/docs/man/nng_ctx_send.3.adoc b/docs/man/nng_ctx_send.3.adoc index 9780c0bd..b2b14d35 100644 --- a/docs/man/nng_ctx_send.3.adoc +++ b/docs/man/nng_ctx_send.3.adoc @@ -66,6 +66,7 @@ None. (The operation completes asynchronously.) == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was aborted. `NNG_ECLOSED`:: The context _ctx_ is not open. `NNG_EMSGSIZE`:: The message is too large. @@ -76,6 +77,7 @@ None. (The operation completes asynchronously.) == SEE ALSO +[.text-left] <<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, <<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, diff --git a/docs/man/nng_ctx_setopt.3.adoc b/docs/man/nng_ctx_setopt.3.adoc index a81b20f4..49ac3742 100644 --- a/docs/man/nng_ctx_setopt.3.adoc +++ b/docs/man/nng_ctx_setopt.3.adoc @@ -92,6 +92,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket. `NNG_EINVAL`:: The value being passed is invalid. `NNG_ENOTSUP`:: The option _opt_ is not supported. @@ -100,6 +101,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_ctx_getopt.3#,nng_ctx_getopt(3)>>, <<nng_setopt.3#,nng_setopt(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_cv_alloc.3supp.adoc b/docs/man/nng_cv_alloc.3supp.adoc index ac059a92..e80c3ce7 100644 --- a/docs/man/nng_cv_alloc.3supp.adoc +++ b/docs/man/nng_cv_alloc.3supp.adoc @@ -44,10 +44,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_cv_free.3supp#,nng_cv_free(3supp)>>, <<nng_cv_until.3supp#,nng_cv_until(3supp)>>, <<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, diff --git a/docs/man/nng_cv_free.3supp.adoc b/docs/man/nng_cv_free.3supp.adoc index 3c076093..dc7e5ffd 100644 --- a/docs/man/nng_cv_free.3supp.adoc +++ b/docs/man/nng_cv_free.3supp.adoc @@ -37,5 +37,6 @@ None. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_cv_until.3supp.adoc b/docs/man/nng_cv_until.3supp.adoc index 9cf49e4d..707b42b3 100644 --- a/docs/man/nng_cv_until.3supp.adoc +++ b/docs/man/nng_cv_until.3supp.adoc @@ -79,6 +79,7 @@ None. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, <<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>, diff --git a/docs/man/nng_cv_wait.3supp.adoc b/docs/man/nng_cv_wait.3supp.adoc index 005fe0c7..ab741815 100644 --- a/docs/man/nng_cv_wait.3supp.adoc +++ b/docs/man/nng_cv_wait.3supp.adoc @@ -75,6 +75,7 @@ None. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_cv_until.3supp#,nng_cv_until(3supp)>>, <<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>, diff --git a/docs/man/nng_cv_wake.3supp.adoc b/docs/man/nng_cv_wake.3supp.adoc index 75642884..569e4aef 100644 --- a/docs/man/nng_cv_wake.3supp.adoc +++ b/docs/man/nng_cv_wake.3supp.adoc @@ -50,6 +50,7 @@ None. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_cv_until.3supp#,nng_cv_until(3supp)>>, <<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, diff --git a/docs/man/nng_cv_wake1.3supp.adoc b/docs/man/nng_cv_wake1.3supp.adoc index 29a4ed88..cea7387c 100644 --- a/docs/man/nng_cv_wake1.3supp.adoc +++ b/docs/man/nng_cv_wake1.3supp.adoc @@ -51,6 +51,7 @@ None. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_cv_until.3supp#,nng_cv_until(3supp)>>, <<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, diff --git a/docs/man/nng_device.3.adoc b/docs/man/nng_device.3.adoc index 4f036d03..807d8e54 100644 --- a/docs/man/nng_device.3.adoc +++ b/docs/man/nng_device.3.adoc @@ -58,7 +58,7 @@ In this case sockets _s1_ and _s2_ must be "`compatible`" with each other, which is to say that they should represent the opposite halves of a two protocol pattern, or both be the same protocol for a single protocol pattern. -For example, if _s1_ is a <<nng_pub.7#,_pub_>> socket, then _s2_ must +For example, if _s1_ is a <<nng_pub.7#,_pub_>> socket, then _s2_ must be a <<nng_sub.7#,_sub_>> socket. Or, if _s1_ is a <<nng_bus.7#,_bus_>> socket, then _s2_ must also be a _bus_ socket. @@ -102,12 +102,14 @@ one occurs, or if one of the sockets is closed. == ERRORS +[horizontal] `NNG_ECLOSED`:: At least one of the sockets is not open. `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EINVAL`:: The sockets are not compatible, or are both invalid. == SEE ALSO +[.text-left] <<nng_options.5#,nng_options(5)>>, <<nng_socket.5#,nng_socket(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_dial.3.adoc b/docs/man/nng_dial.3.adoc index d2eb7605..50fa229c 100644 --- a/docs/man/nng_dial.3.adoc +++ b/docs/man/nng_dial.3.adoc @@ -49,7 +49,7 @@ It may even have some of each at the same time! Normally, the first attempt to connect to the address indicated by _url_ is done synchronously, including any necessary name resolution. As a result, a failure, such as if the connection is refused, will be returned -immediately, and no further action will be taken. +immediately, and no further action will be taken. However, if the special value `NNG_FLAG_NONBLOCK` is supplied in _flags_, then the connection attempt is made asynchronously. @@ -62,7 +62,7 @@ it also generally makes diagnosing failures somewhat more difficult. Because the dialer is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using `<<nng_dialer_create.3#,nng_dialer_create()>>` and +using `<<nng_dialer_create.3#,nng_dialer_create()>>` and `<<nng_dialer_start.3#,nng_dialer_start()>>` instead. == RETURN VALUES @@ -71,6 +71,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINVAL`:: An invalid _url_ was specified. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_ECONNREFUSED`:: The remote peer refused the connection. @@ -83,6 +84,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dialer_close.3#,nng_dialer_close(3)>>, <<nng_dialer_create.3#,nng_dialer_create(3)>> <<nng_dialer_start.3#,nng_dialer_start(3)>>, diff --git a/docs/man/nng_dialer.5.adoc b/docs/man/nng_dialer.5.adoc index b2c24325..cd639711 100644 --- a/docs/man/nng_dialer.5.adoc +++ b/docs/man/nng_dialer.5.adoc @@ -66,6 +66,7 @@ before it is opened, to prevent confusion with valid open dialers. == SEE ALSO +[.text-left] <<nng_dial.3#,nng_dial(3)>>, <<nng_dialer_close.3#,nng_dialer_close(3)>>, <<nng_dialer_create.3#,nng_dialer_create(3)>>, diff --git a/docs/man/nng_dialer_close.3.adoc b/docs/man/nng_dialer_close.3.adoc index a89ad683..7c516bdf 100644 --- a/docs/man/nng_dialer_close.3.adoc +++ b/docs/man/nng_dialer_close.3.adoc @@ -42,10 +42,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: Parameter _d_ does not refer to an open listener. == SEE ALSO +[.text-left] <<nng_close.3#,nng_close(3)>>, <<nng_dial.3#,nng_dial(3)>>, <<nng_dialer_create.3#,nng_dialer_create(3)>> diff --git a/docs/man/nng_dialer_create.3.adoc b/docs/man/nng_dialer_create.3.adoc index b7ce82fa..c33c778b 100644 --- a/docs/man/nng_dialer_create.3.adoc +++ b/docs/man/nng_dialer_create.3.adoc @@ -61,12 +61,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINVAL`:: An invalid _url_ was specified. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_ENOMEM`:: Insufficient memory is available. == SEE ALSO +[.text-left] <<nng_dial.3#,nng_dial(3)>>, <<nng_dialer_close.3#,nng_dialer_close(3)>>, <<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>, diff --git a/docs/man/nng_dialer_getopt.3.adoc b/docs/man/nng_dialer_getopt.3.adoc index e9054b89..f657a530 100644 --- a/docs/man/nng_dialer_getopt.3.adoc +++ b/docs/man/nng_dialer_getopt.3.adoc @@ -125,6 +125,7 @@ These functions returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer. `NNG_EINVAL`:: Size of destination _val_ too small for object. @@ -134,6 +135,7 @@ These functions returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dialer_create.3#,nng_dialer_create(3)>> <<nng_dialer_setopt.3#,nng_dialer_setopt(3)>> <<nng_strdup.3#,nng_strdup(3)>>, diff --git a/docs/man/nng_dialer_id.3.adoc b/docs/man/nng_dialer_id.3.adoc index a25125f4..35fb2665 100644 --- a/docs/man/nng_dialer_id.3.adoc +++ b/docs/man/nng_dialer_id.3.adoc @@ -47,5 +47,6 @@ None. == SEE ALSO +[.text-left] <<nng_dialer.5#,nng_dialer(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_dialer_setopt.3.adoc b/docs/man/nng_dialer_setopt.3.adoc index 540d5c2b..6ac67639 100644 --- a/docs/man/nng_dialer_setopt.3.adoc +++ b/docs/man/nng_dialer_setopt.3.adoc @@ -109,6 +109,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer. `NNG_EINVAL`:: The value being passed is invalid. @@ -118,6 +119,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dialer_create.3#,nng_dialer_create(3)>> <<nng_dialer_getopt.3#,nng_dialer_getopt(3)>> <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_dialer_start.3.adoc b/docs/man/nng_dialer_start.3.adoc index 45dd0d6f..6a333543 100644 --- a/docs/man/nng_dialer_start.3.adoc +++ b/docs/man/nng_dialer_start.3.adoc @@ -35,7 +35,7 @@ which will be attached to the dialer's socket. Normally, the first attempt to connect to the dialer's address is done synchronously, including any necessary name resolution. As a result, a failure, such as if the connection is refused, will be returned -immediately, and no further action will be taken. +immediately, and no further action will be taken. However, if the special value `NNG_FLAG_NONBLOCK` is supplied in _flags_, then the connection attempt is made asynchronously. @@ -55,6 +55,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINVAL`:: An invalid _url_ was specified. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_ECONNREFUSED`:: The remote peer refused the connection. @@ -68,6 +69,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dial.3#,nng_dial(3)>>, <<nng_dialer_create.3#,nng_dialer_create(3)>> <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_duration.5.adoc b/docs/man/nng_duration.5.adoc index 381d2ea4..de486419 100644 --- a/docs/man/nng_duration.5.adoc +++ b/docs/man/nng_duration.5.adoc @@ -45,5 +45,6 @@ Zero length duration; used to perform a single polling operation. == SEE ALSO +[.text-left] <<nng_options.5#,nng_options(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_free.3.adoc b/docs/man/nng_free.3.adoc index ac110db1..d09f3a22 100644 --- a/docs/man/nng_free.3.adoc +++ b/docs/man/nng_free.3.adoc @@ -47,6 +47,7 @@ None. == SEE ALSO +[.text-left] <<nng_alloc.3#,nng_alloc(3)>>, <<nng_recv.3#,nng_recv(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_getopt.3.adoc b/docs/man/nng_getopt.3.adoc index 45c5a295..4d6ae868 100644 --- a/docs/man/nng_getopt.3.adoc +++ b/docs/man/nng_getopt.3.adoc @@ -117,6 +117,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket. `NNG_EINVAL`:: Size of destination _val_ too small for object. @@ -126,6 +127,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>, <<nng_listener_getopt.3#,nng_listener_getopt(3)>>, <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, diff --git a/docs/man/nng_http_client_alloc.3http.adoc b/docs/man/nng_http_client_alloc.3http.adoc index f6fa2862..de659549 100644 --- a/docs/man/nng_http_client_alloc.3http.adoc +++ b/docs/man/nng_http_client_alloc.3http.adoc @@ -16,12 +16,12 @@ nng_http_client_alloc - allocate HTTP client == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_client_alloc(nng_http_client *clientp, const nng_url *url); ------------ +---- == DESCRIPTION @@ -35,11 +35,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: HTTP not supported. == SEE ALSO +[.text-left] <<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, <<nng_http_client_free.3http#,nng_http_client_free(3http)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_http_client_connect.3http.adoc b/docs/man/nng_http_client_connect.3http.adoc index 397c7f2f..ed8a7f98 100644 --- a/docs/man/nng_http_client_connect.3http.adoc +++ b/docs/man/nng_http_client_connect.3http.adoc @@ -16,12 +16,12 @@ nng_http_client_connect - establish HTTP client connection == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> void nng_http_client_connect(nng_http_client *client, nng_aio *aio); ------------ +---- == DESCRIPTION @@ -44,6 +44,7 @@ None. == ERRORS +[horizontal] `NNG_EADDRINVAL`:: The server is configured with an invalid address. `NNG_ECANCELED`:: The operation was aborted. `NNG_ECONNREFUSED`:: The TCP connection was refused by the server. @@ -85,6 +86,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_get_output.3#,nng_aio_get_output(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, <<nng_aio_wait.3#,nng_aio_wait(3)>>, diff --git a/docs/man/nng_http_client_free.3http.adoc b/docs/man/nng_http_client_free.3http.adoc index 33d6cf05..80b99a6a 100644 --- a/docs/man/nng_http_client_free.3http.adoc +++ b/docs/man/nng_http_client_free.3http.adoc @@ -16,12 +16,12 @@ nng_http_client_free - free HTTP client == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> void nng_http_client_free(nng_http_client *client); ------------ +---- == DESCRIPTION @@ -42,6 +42,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_client_alloc.3http#,nng_http_client_alloc(3)>>, <<nng_http_client_connect.3http#,nng_http_client_connect(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_client_get_tls.3http.adoc b/docs/man/nng_http_client_get_tls.3http.adoc index 1632ecda..38c59ea5 100644 --- a/docs/man/nng_http_client_get_tls.3http.adoc +++ b/docs/man/nng_http_client_get_tls.3http.adoc @@ -16,12 +16,12 @@ nng_http_client_get_tls - get HTTP client TLS configuration == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_client_get_tls(nng_http_client *client, nng_tls_config **cfgp); ------------ +---- == DESCRIPTION @@ -37,11 +37,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: Either HTTP or TLS not supported. == SEE ALSO +[.text-left] <<nng_http_client_alloc.3http#,nng_http_client_alloc(3http)>>, <<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, <<nng_http_client_set_tls.3http#,nng_http_client_set_tls(3http)>>, diff --git a/docs/man/nng_http_client_set_tls.3http.adoc b/docs/man/nng_http_client_set_tls.3http.adoc index 5ed8bda8..0a00d138 100644 --- a/docs/man/nng_http_client_set_tls.3http.adoc +++ b/docs/man/nng_http_client_set_tls.3http.adoc @@ -16,12 +16,12 @@ nng_http_client_set_tls - set HTTP client TLS configuration == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_client_set_tls(nng_http_client *client, nng_tls_config *cfg); ------------ +---- == DESCRIPTION @@ -42,11 +42,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: Either HTTP or TLS not supported. == SEE ALSO +[.text-left] <<nng_http_client_alloc.3http#,nng_http_client_alloc(3http)>>, <<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, <<nng_http_client_get_tls.3http#,nng_http_client_get_tls(3http)>>, diff --git a/docs/man/nng_http_conn_close.3http.adoc b/docs/man/nng_http_conn_close.3http.adoc index 2861fa1b..18cca674 100644 --- a/docs/man/nng_http_conn_close.3http.adoc +++ b/docs/man/nng_http_conn_close.3http.adoc @@ -40,6 +40,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_http_conn_read.3http.adoc b/docs/man/nng_http_conn_read.3http.adoc index f6e9fad1..671af4aa 100644 --- a/docs/man/nng_http_conn_read.3http.adoc +++ b/docs/man/nng_http_conn_read.3http.adoc @@ -54,6 +54,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -64,6 +65,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_count.3#,nng_aio_count(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_http_conn_read_all.3http.adoc b/docs/man/nng_http_conn_read_all.3http.adoc index 0a8140fd..a091edfa 100644 --- a/docs/man/nng_http_conn_read_all.3http.adoc +++ b/docs/man/nng_http_conn_read_all.3http.adoc @@ -56,6 +56,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -66,6 +67,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_count.3#,nng_aio_count(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_http_conn_read_req.3http.adoc b/docs/man/nng_http_conn_read_req.3http.adoc index 4e1c5bf3..f4131f19 100644 --- a/docs/man/nng_http_conn_read_req.3http.adoc +++ b/docs/man/nng_http_conn_read_req.3http.adoc @@ -47,6 +47,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -56,6 +57,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_http_conn_read_res.3http.adoc b/docs/man/nng_http_conn_read_res.3http.adoc index 4a31d0c8..4e2f2713 100644 --- a/docs/man/nng_http_conn_read_res.3http.adoc +++ b/docs/man/nng_http_conn_read_res.3http.adoc @@ -48,6 +48,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -57,6 +58,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_http_conn_write.3http.adoc b/docs/man/nng_http_conn_write.3http.adoc index 24daa0b7..5d297e80 100644 --- a/docs/man/nng_http_conn_write.3http.adoc +++ b/docs/man/nng_http_conn_write.3http.adoc @@ -53,6 +53,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -63,6 +64,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_count.3#,nng_aio_count(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_http_conn_write_all.3http.adoc b/docs/man/nng_http_conn_write_all.3http.adoc index d29af75e..4c25412f 100644 --- a/docs/man/nng_http_conn_write_all.3http.adoc +++ b/docs/man/nng_http_conn_write_all.3http.adoc @@ -58,7 +58,7 @@ an `Content-Length` header, and possibly a `Content-Type` header. TIP: An easier solution to sending HTTP content data, is to include the conten with the request or reply using a function like `<<nng_http_req_copy_data.3http#,nng_http_req_copy_data()>>`. -In that case, the body data will be written automatically by the +In that case, the body data will be written automatically by the `<<nng_http_conn_write_req.3http#,http_conn_write_req()>>` or `<<nng_http_conn_write_req.3http#,http_conn_write_res()>>` function. @@ -68,6 +68,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -78,6 +79,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_count.3#,nng_aio_count(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, diff --git a/docs/man/nng_http_conn_write_req.3http.adoc b/docs/man/nng_http_conn_write_req.3http.adoc index faffb3ca..453f0397 100644 --- a/docs/man/nng_http_conn_write_req.3http.adoc +++ b/docs/man/nng_http_conn_write_req.3http.adoc @@ -45,6 +45,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -54,6 +55,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, <<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, diff --git a/docs/man/nng_http_conn_write_res.3http.adoc b/docs/man/nng_http_conn_write_res.3http.adoc index 219b771e..2bab9a31 100644 --- a/docs/man/nng_http_conn_write_res.3http.adoc +++ b/docs/man/nng_http_conn_write_res.3http.adoc @@ -44,7 +44,7 @@ That result will either be zero or an error code. By default, for `HTTP/1.1` connections, the connection is kept open, and will be reused to receive new requests. -If however the _res_ contains a header of `Connection:` with a value +If however the _res_ contains a header of `Connection:` with a value of `Close` (case-insensitive) or the response corresponds to `HTTP/1.0`, then the connection is immediately after sending the response. @@ -54,6 +54,7 @@ None. == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was canceled. `NNG_ECLOSED`:: The connection was closed. `NNG_ECONNRESET`:: The peer closed the connection. @@ -63,6 +64,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_result.3#,nng_aio_result(3)>>, <<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, diff --git a/docs/man/nng_http_handler_alloc.3http.adoc b/docs/man/nng_http_handler_alloc.3http.adoc index be6f2568..630871cc 100644 --- a/docs/man/nng_http_handler_alloc.3http.adoc +++ b/docs/man/nng_http_handler_alloc.3http.adoc @@ -108,7 +108,7 @@ the extension, then `application/octet-stream` is used. The third member of this family, `nng_http_handler_alloc_file()`, creates a handler to serve up a single file; it does not traverse directories -or search for `index.html` or `index.htm` files. +or search for `index.html` or `index.htm` files. The `Content-Type` will be set automatically based upon the extension of the requsted file name. @@ -129,12 +129,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: An invalid _path_ was specified. `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_aio_finish.3#,nng_aio_finish(3)>>, <<nng_aio_get_input.3#,nng_aio_get_input(3)>>, <<nng_aio_set_output.3#,nng_aio_set_output(3)>>, diff --git a/docs/man/nng_http_handler_free.3http.adoc b/docs/man/nng_http_handler_free.3http.adoc index 3528ff29..c4525703 100644 --- a/docs/man/nng_http_handler_free.3http.adoc +++ b/docs/man/nng_http_handler_free.3http.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_handler_get_data.3http.adoc b/docs/man/nng_http_handler_get_data.3http.adoc index f1a1a700..b926fb2a 100644 --- a/docs/man/nng_http_handler_get_data.3http.adoc +++ b/docs/man/nng_http_handler_get_data.3http.adoc @@ -40,6 +40,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_handler_set_data.3http#,nng_http_server_set_data(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, diff --git a/docs/man/nng_http_handler_set_data.3http.adoc b/docs/man/nng_http_handler_set_data.3http.adoc index a6be46fb..120c4618 100644 --- a/docs/man/nng_http_handler_set_data.3http.adoc +++ b/docs/man/nng_http_handler_set_data.3http.adoc @@ -42,11 +42,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_handler_get_data.3http#,nng_http_server_get_data(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, diff --git a/docs/man/nng_http_handler_set_host.3http.adoc b/docs/man/nng_http_handler_set_host.3http.adoc index c286540f..9c3acb80 100644 --- a/docs/man/nng_http_handler_set_host.3http.adoc +++ b/docs/man/nng_http_handler_set_host.3http.adoc @@ -47,11 +47,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_handler_set_method.3http.adoc b/docs/man/nng_http_handler_set_method.3http.adoc index 1ddbb15a..852ddd51 100644 --- a/docs/man/nng_http_handler_set_method.3http.adoc +++ b/docs/man/nng_http_handler_set_method.3http.adoc @@ -48,11 +48,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng_http_req_get_method.3http#,nng_http_req_get_method(3http)>>, diff --git a/docs/man/nng_http_handler_set_tree.3http.adoc b/docs/man/nng_http_handler_set_tree.3http.adoc index 474ac64f..758240e3 100644 --- a/docs/man/nng_http_handler_set_tree.3http.adoc +++ b/docs/man/nng_http_handler_set_tree.3http.adoc @@ -38,11 +38,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng_http_req_get_method.3http#,nng_http_req_get_method(3http)>>, diff --git a/docs/man/nng_http_hijack.3http.adoc b/docs/man/nng_http_hijack.3http.adoc index d10bacfc..1fd45f48 100644 --- a/docs/man/nng_http_hijack.3http.adoc +++ b/docs/man/nng_http_hijack.3http.adoc @@ -38,7 +38,7 @@ This function is most useful when called from a handler function. NOTE: It is the responsibility of the caller to dispose of the underlying connection when it is no longer needed. Furthermore, the HTTP server will no longer send any responses to the -hijacked connection, so the caller should do that as well if appropriate. +hijacked connection, so the caller should do that as well if appropriate. (See `<<nng_http_conn_write_res.3http#,nng_http_conn_write_res()>>`.) TIP: This function is intended to facilitate uses cases that involve changing @@ -51,12 +51,14 @@ None. == ERRORS +[horizontal] `NNG_ECLOSED`:: The connection was closed. `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: HTTP not supported. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_http_conn_write_res.3http#,nng_http_conn_write_res(3http)>>, <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, diff --git a/docs/man/nng_http_req_add_header.3http.adoc b/docs/man/nng_http_req_add_header.3http.adoc index e6eb8844..bdfaccb3 100644 --- a/docs/man/nng_http_req_add_header.3http.adoc +++ b/docs/man/nng_http_req_add_header.3http.adoc @@ -51,11 +51,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_del_header.3http#,nng_http_req_del_header(3http)>>, <<nng_http_req_get_header.3http#,nng_http_req_get_header(3http)>>, diff --git a/docs/man/nng_http_req_alloc.3http.adoc b/docs/man/nng_http_req_alloc.3http.adoc index ab84478a..3a522b3e 100644 --- a/docs/man/nng_http_req_alloc.3http.adoc +++ b/docs/man/nng_http_req_alloc.3http.adoc @@ -36,11 +36,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. `NNG_ENOTSUP`:: HTTP support not configured. == SEE ALSO +[.text-left] <<nng_http_conn_read_req.3http#,nng_http_conn_read_req(3http)>>, <<nng_http_conn_write_req.3http#,nng_http_conn_write_req(3http)>>, <<nng_http_req_add_header.3http#,nng_http_req_add_header(3http)>>, diff --git a/docs/man/nng_http_req_copy_data.3http.adoc b/docs/man/nng_http_req_copy_data.3http.adoc index 5b52dcf2..a6eb9382 100644 --- a/docs/man/nng_http_req_copy_data.3http.adoc +++ b/docs/man/nng_http_req_copy_data.3http.adoc @@ -48,11 +48,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_conn_write_req.3http#,nng_http_conn_write_req(3http)>>, <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_set_data.3http#,nng_http_req_set_data(3http)>>, diff --git a/docs/man/nng_http_req_del_header.3http.adoc b/docs/man/nng_http_req_del_header.3http.adoc index ff3d045f..48a4326d 100644 --- a/docs/man/nng_http_req_del_header.3http.adoc +++ b/docs/man/nng_http_req_del_header.3http.adoc @@ -39,11 +39,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOENT`:: No header with the key _key_ was present. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_add_header.3http#,nng_http_req_add_header(3http)>>, <<nng_http_req_del_header.3http#,nng_http_req_del_header(3http)>>, diff --git a/docs/man/nng_http_req_free.3http.adoc b/docs/man/nng_http_req_free.3http.adoc index 7d7b2a6a..df86c5da 100644 --- a/docs/man/nng_http_req_free.3http.adoc +++ b/docs/man/nng_http_req_free.3http.adoc @@ -38,5 +38,6 @@ None. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_req_get_header.3http.adoc b/docs/man/nng_http_req_get_header.3http.adoc index 11c5eed6..8fbdb2b0 100644 --- a/docs/man/nng_http_req_get_header.3http.adoc +++ b/docs/man/nng_http_req_get_header.3http.adoc @@ -45,6 +45,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_add_header.3http#,nng_http_req_add_header(3http)>>, <<nng_http_req_set_header.3http#,nng_http_req_set_header(3http)>>, diff --git a/docs/man/nng_http_req_get_method.3http.adoc b/docs/man/nng_http_req_get_method.3http.adoc index 795978a1..a9420c10 100644 --- a/docs/man/nng_http_req_get_method.3http.adoc +++ b/docs/man/nng_http_req_get_method.3http.adoc @@ -40,6 +40,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_set_method.3http#,nng_http_req_set_method(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_req_get_uri.3http.adoc b/docs/man/nng_http_req_get_uri.3http.adoc index 446b0112..e7412c5b 100644 --- a/docs/man/nng_http_req_get_uri.3http.adoc +++ b/docs/man/nng_http_req_get_uri.3http.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_set_uri.3http#,nng_http_req_set_uri(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_req_get_version.3http.adoc b/docs/man/nng_http_req_get_version.3http.adoc index 7bc14190..9049d3f5 100644 --- a/docs/man/nng_http_req_get_version.3http.adoc +++ b/docs/man/nng_http_req_get_version.3http.adoc @@ -39,6 +39,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_set_version.3http#,nng_http_req_set_version(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_req_set_data.3http.adoc b/docs/man/nng_http_req_set_data.3http.adoc index 1161476a..5988386e 100644 --- a/docs/man/nng_http_req_set_data.3http.adoc +++ b/docs/man/nng_http_req_set_data.3http.adoc @@ -16,12 +16,12 @@ nng_http_req_set_data - set HTTP request body == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_req_set_data(nng_http_req *req, const void *body, size_t size); ------------ +---- == DESCRIPTION @@ -50,11 +50,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_conn_write_req.3http#,nng_http_conn_write_req(3http)>>, <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_copy_data.3http#,nng_http_req_copy_data(3http)>>, diff --git a/docs/man/nng_http_req_set_header.3http.adoc b/docs/man/nng_http_req_set_header.3http.adoc index 4102881a..04f736ef 100644 --- a/docs/man/nng_http_req_set_header.3http.adoc +++ b/docs/man/nng_http_req_set_header.3http.adoc @@ -45,11 +45,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_add_header.3http#,nng_http_req_add_header(3http)>>, <<nng_http_req_del_header.3http#,nng_http_req_del_header(3http)>>, diff --git a/docs/man/nng_http_req_set_method.3http.adoc b/docs/man/nng_http_req_set_method.3http.adoc index 786cc071..5cb14926 100644 --- a/docs/man/nng_http_req_set_method.3http.adoc +++ b/docs/man/nng_http_req_set_method.3http.adoc @@ -16,12 +16,12 @@ nng_http_req_set_method - set HTTP request method == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_req_set_method(nng_http_req *req, const char *method); ------------ +---- == DESCRIPTION @@ -40,11 +40,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_get_method.3http#,nng_http_req_get_method(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_req_set_uri.3http.adoc b/docs/man/nng_http_req_set_uri.3http.adoc index 25cd42a3..bd3cb586 100644 --- a/docs/man/nng_http_req_set_uri.3http.adoc +++ b/docs/man/nng_http_req_set_uri.3http.adoc @@ -46,11 +46,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_get_uri.3http#,nng_http_req_get_uri(3http)>>, <<nng_url_parse.3#,nng_url_parse(3)>>, diff --git a/docs/man/nng_http_req_set_version.3http.adoc b/docs/man/nng_http_req_set_version.3http.adoc index ae0a5fba..24f9ace5 100644 --- a/docs/man/nng_http_req_set_version.3http.adoc +++ b/docs/man/nng_http_req_set_version.3http.adoc @@ -16,12 +16,12 @@ nng_http_req_set_version - set HTTP request protocol version == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_req_set_version(nng_http_req *req, const char *version); ------------ +---- == DESCRIPTION @@ -46,11 +46,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng_http_req_get_version.3http#,nng_http_req_get_version(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_res_add_header.3http.adoc b/docs/man/nng_http_res_add_header.3http.adoc index cdc325ed..8c6dfcf0 100644 --- a/docs/man/nng_http_res_add_header.3http.adoc +++ b/docs/man/nng_http_res_add_header.3http.adoc @@ -51,11 +51,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_del_header.3http#,nng_http_res_del_header(3http)>>, <<nng_http_res_get_header.3http#,nng_http_res_get_header(3http)>>, diff --git a/docs/man/nng_http_res_alloc.3http.adoc b/docs/man/nng_http_res_alloc.3http.adoc index e54f1ad7..2b7699a7 100644 --- a/docs/man/nng_http_res_alloc.3http.adoc +++ b/docs/man/nng_http_res_alloc.3http.adoc @@ -16,12 +16,12 @@ nng_http_res_alloc - allocate HTTP response structure == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> int nng_http_res_alloc(nng_http_res **resp); ------------ +---- == DESCRIPTION @@ -40,11 +40,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. `NNG_ENOTSUP`:: HTTP support not configured. == SEE ALSO +[.text-left] <<nng_http_conn_read_res.3http#,nng_http_conn_read_res(3http)>>, <<nng_http_conn_write_res.3http#,nng_http_conn_write_res(3http)>>, <<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, diff --git a/docs/man/nng_http_res_alloc_error.3http.adoc b/docs/man/nng_http_res_alloc_error.3http.adoc index e777a6a2..f3d54bc4 100644 --- a/docs/man/nng_http_res_alloc_error.3http.adoc +++ b/docs/man/nng_http_res_alloc_error.3http.adoc @@ -43,11 +43,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. `NNG_ENOTSUP`:: HTTP support not configured. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_free.3http#,nng_http_res_free(3http)>>, <<nng_http_res_set_reason.3http#,nng_http_res_set_reason(3http)>>, diff --git a/docs/man/nng_http_res_copy_data.3http.adoc b/docs/man/nng_http_res_copy_data.3http.adoc index 3831d45b..e4d109ba 100644 --- a/docs/man/nng_http_res_copy_data.3http.adoc +++ b/docs/man/nng_http_res_copy_data.3http.adoc @@ -48,11 +48,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_conn_write_res.3http#,nng_http_conn_write_res(3http)>>, <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_set_data.3http#,nng_http_res_set_data(3http)>>, diff --git a/docs/man/nng_http_res_del_header.3http.adoc b/docs/man/nng_http_res_del_header.3http.adoc index 8d204447..9fda3bcd 100644 --- a/docs/man/nng_http_res_del_header.3http.adoc +++ b/docs/man/nng_http_res_del_header.3http.adoc @@ -38,11 +38,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOENT`:: No header with the key _key_ was present. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_add_header.3http#,nng_http_res_add_header(3http)>>, <<nng_http_res_del_header.3http#,nng_http_res_del_header(3http)>>, diff --git a/docs/man/nng_http_res_free.3http.adoc b/docs/man/nng_http_res_free.3http.adoc index f3db4314..0c7f2445 100644 --- a/docs/man/nng_http_res_free.3http.adoc +++ b/docs/man/nng_http_res_free.3http.adoc @@ -38,5 +38,6 @@ None. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_req_alloc(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_res_get_header.3http.adoc b/docs/man/nng_http_res_get_header.3http.adoc index 43f8b317..936d7d3f 100644 --- a/docs/man/nng_http_res_get_header.3http.adoc +++ b/docs/man/nng_http_res_get_header.3http.adoc @@ -45,6 +45,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_add_header.3http#,nng_http_res_add_header(3http)>>, <<nng_http_res_set_header.3http#,nng_http_res_set_header(3http)>>, diff --git a/docs/man/nng_http_res_get_reason.3http.adoc b/docs/man/nng_http_res_get_reason.3http.adoc index 7251f1cc..70d5f1e3 100644 --- a/docs/man/nng_http_res_get_reason.3http.adoc +++ b/docs/man/nng_http_res_get_reason.3http.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_get_status.3http#,nng_http_res_get_status(3http)>>, <<nng_http_res_set_reason.3http#,nng_http_res_set_reason(3http)>>, diff --git a/docs/man/nng_http_res_get_status.3http.adoc b/docs/man/nng_http_res_get_status.3http.adoc index ac780a24..2475c76f 100644 --- a/docs/man/nng_http_res_get_status.3http.adoc +++ b/docs/man/nng_http_res_get_status.3http.adoc @@ -92,8 +92,8 @@ enum { NNG_HTTP_STATUS_INSUFFICIENT_STORAGE = 507, NNG_HTTP_STATUS_LOOP_DETECTED = 508, NNG_HTTP_STATUS_NOT_EXTENDED = 510, - NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED = 511, -} + NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED = 511, +} ---- TIP: When displaying status information to users (or logging such information), @@ -110,6 +110,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_get_reason.3http#,nng_http_res_get_reason(3http)>>, <<nng_http_res_set_status.3http#,nng_http_res_set_status(3http)>>, diff --git a/docs/man/nng_http_res_get_version.3http.adoc b/docs/man/nng_http_res_get_version.3http.adoc index 0b6f76e3..17dbdfec 100644 --- a/docs/man/nng_http_res_get_version.3http.adoc +++ b/docs/man/nng_http_res_get_version.3http.adoc @@ -39,6 +39,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_set_version.3http#,nng_http_res_set_version(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_res_set_data.3http.adoc b/docs/man/nng_http_res_set_data.3http.adoc index ab522ca9..e6d77a2b 100644 --- a/docs/man/nng_http_res_set_data.3http.adoc +++ b/docs/man/nng_http_res_set_data.3http.adoc @@ -50,11 +50,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_conn_write_res.3http#,nng_http_conn_write_res(3http)>>, <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_copy_data.3http#,nng_http_res_copy_data(3http)>>, diff --git a/docs/man/nng_http_res_set_header.3http.adoc b/docs/man/nng_http_res_set_header.3http.adoc index 4d79739a..51265812 100644 --- a/docs/man/nng_http_res_set_header.3http.adoc +++ b/docs/man/nng_http_res_set_header.3http.adoc @@ -45,11 +45,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_add_header.3http#,nng_http_res_add_header(3http)>>, <<nng_http_res_del_header.3http#,nng_http_res_del_header(3http)>>, diff --git a/docs/man/nng_http_res_set_reason.3http.adoc b/docs/man/nng_http_res_set_reason.3http.adoc index fed03c2f..955256f4 100644 --- a/docs/man/nng_http_res_set_reason.3http.adoc +++ b/docs/man/nng_http_res_set_reason.3http.adoc @@ -25,8 +25,8 @@ int nng_http_res_set_reason(nng_http_res *res, const char *reason); == DESCRIPTION -The `nng_http_res_set_reason()` sets the human readable "reason phrase" -associated with the response _res_ to _reason_. +The `nng_http_res_set_reason()` sets the human readable "`reason phrase`" +associated with the response _res_ to _reason_. If the value of _reason_ is `NULL` (the default), then a default reason phrase is supplied based upon the value of the status code (see @@ -43,11 +43,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_get_reason.3http#,nng_http_req_get_reason(3http)>>, <<nng_http_res_set_status.3http#,nng_http_req_set_status(3http)>>, diff --git a/docs/man/nng_http_res_set_status.3http.adoc b/docs/man/nng_http_res_set_status.3http.adoc index b3b9700c..cf08d2cb 100644 --- a/docs/man/nng_http_res_set_status.3http.adoc +++ b/docs/man/nng_http_res_set_status.3http.adoc @@ -95,8 +95,8 @@ enum { NNG_HTTP_STATUS_INSUFFICIENT_STORAGE = 507, NNG_HTTP_STATUS_LOOP_DETECTED = 508, NNG_HTTP_STATUS_NOT_EXTENDED = 510, - NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED = 511, -} + NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED = 511, +}; ---- Please see the relevant HTTP RFCs for the semantics and correct @@ -112,10 +112,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_res_get_status.3http#,nng_http_req_get_status(3http)>>, <<nng_http_res_set_reason.3http#,nng_http_req_set_reason(3http)>>, diff --git a/docs/man/nng_http_res_set_version.3http.adoc b/docs/man/nng_http_res_set_version.3http.adoc index 48998c5e..38344690 100644 --- a/docs/man/nng_http_res_set_version.3http.adoc +++ b/docs/man/nng_http_res_set_version.3http.adoc @@ -46,11 +46,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory to perform the operation. `NNG_ENOTSUP`:: No support for HTTP in the library. == SEE ALSO +[.text-left] <<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, <<nng_http_req_get_version.3http#,nng_http_req_get_version(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_server_add_handler.3http.adoc b/docs/man/nng_http_server_add_handler.3http.adoc index 31285ede..ff2dee2a 100644 --- a/docs/man/nng_http_server_add_handler.3http.adoc +++ b/docs/man/nng_http_server_add_handler.3http.adoc @@ -43,6 +43,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINUSE`:: Handler conflicts with another handler. `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: HTTP not supported. @@ -50,6 +51,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, <<nng_http_server_del_handler.3http#,nng_http_server_del_handler(3http)>>, <<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, diff --git a/docs/man/nng_http_server_del_handler.3http.adoc b/docs/man/nng_http_server_del_handler.3http.adoc index 868ff73e..a90517c5 100644 --- a/docs/man/nng_http_server_del_handler.3http.adoc +++ b/docs/man/nng_http_server_del_handler.3http.adoc @@ -37,11 +37,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOENT`:: Handler is not registered with server. `NNG_ENOTSUP`:: HTTP not supported. == SEE ALSO +[.text-left] <<nng_http_handler_free.3http#,nng_http_handler_free(3http)>>, <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_http_server_get_tls.3http.adoc b/docs/man/nng_http_server_get_tls.3http.adoc index 28986b93..ec3953e8 100644 --- a/docs/man/nng_http_server_get_tls.3http.adoc +++ b/docs/man/nng_http_server_get_tls.3http.adoc @@ -37,11 +37,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: Either HTTP or TLS not supported. == SEE ALSO +[.text-left] <<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, <<nng_http_server_set_tls.3http#,nng_http_server_set_tls(3http)>>, <<nng_http_server_start.3http#,nng_http_server_start(3http)>>, diff --git a/docs/man/nng_http_server_hold.3http.adoc b/docs/man/nng_http_server_hold.3http.adoc index 164a7487..f7e11b4b 100644 --- a/docs/man/nng_http_server_hold.3http.adoc +++ b/docs/man/nng_http_server_hold.3http.adoc @@ -51,11 +51,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: HTTP not supported. == SEE ALSO +[.text-left] <<nng_http_server_add_handler.3http#,nng_http_server_add_handler(3http)>>, <<nng_http_server_release.3http#,nng_http_server_release(3http)>>, <<nng_http_server_stop.3http#,nng_http_server_stop(3http)>>, diff --git a/docs/man/nng_http_server_release.3http.adoc b/docs/man/nng_http_server_release.3http.adoc index 9f3ab798..62aff752 100644 --- a/docs/man/nng_http_server_release.3http.adoc +++ b/docs/man/nng_http_server_release.3http.adoc @@ -16,12 +16,12 @@ nng_http_server_release - release HTTP server instance == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> void nng_http_server_release(nng_http_server *server); ------------ +---- == DESCRIPTION @@ -48,6 +48,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, <<nng_http_server_stop.3http#,nng_http_server_stop(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_http_server_set_tls.3http.adoc b/docs/man/nng_http_server_set_tls.3http.adoc index 25d26fa5..ed42353e 100644 --- a/docs/man/nng_http_server_set_tls.3http.adoc +++ b/docs/man/nng_http_server_set_tls.3http.adoc @@ -46,12 +46,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBUSY`:: Server instance is running. `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: Either HTTP or TLS not supported. == SEE ALSO +[.text-left] <<nng_http_server_get_tls.3http#,nng_http_server_get_tls(3http)>>, <<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, <<nng_http_server_start.3http#,nng_http_server_start(3http)>>, diff --git a/docs/man/nng_http_server_start.3http.adoc b/docs/man/nng_http_server_start.3http.adoc index 7a631f67..fde77008 100644 --- a/docs/man/nng_http_server_start.3http.adoc +++ b/docs/man/nng_http_server_start.3http.adoc @@ -35,6 +35,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINUSE`:: The TCP port is unavaialble. `NNG_EADDRINVAL`:: The server is configured with an invalid address. `NNG_ENOMEM`:: Insufficient free memory exists. @@ -42,6 +43,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, <<nng_http_server_release.3http#,nng_http_server_release(3http)>>, <<nng_http_server_stop.3http#,nng_http_server_stop(3http)>>, diff --git a/docs/man/nng_http_server_stop.3http.adoc b/docs/man/nng_http_server_stop.3http.adoc index ccb926f4..bf45adc9 100644 --- a/docs/man/nng_http_server_stop.3http.adoc +++ b/docs/man/nng_http_server_stop.3http.adoc @@ -16,12 +16,12 @@ nng_http_server_stop - stop HTTP server == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/http/http.h> void nng_http_server_stop(nng_http_server *server); ------------ +---- == DESCRIPTION @@ -39,6 +39,7 @@ None. == SEE ALSO +[.text-left] <<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, <<nng_http_server_start.3http#,nng_http_server_start(3http)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_inproc.7.adoc b/docs/man/nng_inproc.7.adoc index 987f6b84..cfd3806d 100644 --- a/docs/man/nng_inproc.7.adoc +++ b/docs/man/nng_inproc.7.adoc @@ -60,9 +60,10 @@ the actual structure is of type === Transport Options The _inproc_ transport has no special options. - + == SEE ALSO +[.text-left] <<nng_inproc_register.3#,nng_inproc_register(3)>>, <<nng_sockaddr_inproc.5#,nng_sockaddr_inproc(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_inproc_register.3.adoc b/docs/man/nng_inproc_register.3.adoc index eee8523c..2f0bcba5 100644 --- a/docs/man/nng_inproc_register.3.adoc +++ b/docs/man/nng_inproc_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_inproc.7#,nng_inproc(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_iov.5.adoc b/docs/man/nng_iov.5.adoc index 55c2d19e..161dd297 100644 --- a/docs/man/nng_iov.5.adoc +++ b/docs/man/nng_iov.5.adoc @@ -49,6 +49,7 @@ The following structure members are present: == SEE ALSO +[.text-left] <<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>, <<nng_aio.5#,nng_aio(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_ipc.7.adoc b/docs/man/nng_ipc.7.adoc index ef9fd1b1..6a7f3972 100644 --- a/docs/man/nng_ipc.7.adoc +++ b/docs/man/nng_ipc.7.adoc @@ -146,5 +146,6 @@ Zones (and this option) are only supported on Solaris and illumos systems. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_ipc_register.3.adoc b/docs/man/nng_ipc_register.3.adoc index f0421f16..e0fd514c 100644 --- a/docs/man/nng_ipc_register.3.adoc +++ b/docs/man/nng_ipc_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_ipc.7#,nng_ipc(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_listen.3.adoc b/docs/man/nng_listen.3.adoc index 6a9e8f6f..b8e0ff5b 100644 --- a/docs/man/nng_listen.3.adoc +++ b/docs/man/nng_listen.3.adoc @@ -16,11 +16,11 @@ nng_listen - create and start listener == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> int nng_listen(nng_socket s, const char *url, nng_listener *lp, int flags); ------------ +---- == DESCRIPTION @@ -56,7 +56,7 @@ it also generally makes diagnosing failures somewhat more difficult. Because the listener is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using `<<nng_listener_create.3#,nng_listener_create()>>` and +using `<<nng_listener_create.3#,nng_listener_create()>>` and `<<nng_listener_start.3#,nng_listener_start()>>` instead. The created listener will continue to accept new connections, associating @@ -68,6 +68,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINUSE`:: The address specified by _url_ is already in use. `NNG_EADDRINVAL`:: An invalid _url_ was specified. `NNG_ECLOSED`:: The socket _s_ is not open. @@ -76,6 +77,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dial.3#,nng_dial(3)>>, <<nng_listener_close.3#,nng_listener_close(3)>>, <<nng_listener_create.3#,nng_listener_create(3)>> diff --git a/docs/man/nng_listener.5.adoc b/docs/man/nng_listener.5.adoc index 6da63f36..6df0f5f1 100644 --- a/docs/man/nng_listener.5.adoc +++ b/docs/man/nng_listener.5.adoc @@ -63,6 +63,7 @@ before it is opened, to prevent confusion with valid open listener. == SEE ALSO +[.text-left] <<nng_listen.3#,nng_listen(3)>>, <<nng_listener_close.3#,nng_listener_close(3)>>, <<nng_listener_create.3#,nng_listener_create(3)>>, diff --git a/docs/man/nng_listener_close.3.adoc b/docs/man/nng_listener_close.3.adoc index 6ef7b87a..9411a01b 100644 --- a/docs/man/nng_listener_close.3.adoc +++ b/docs/man/nng_listener_close.3.adoc @@ -42,10 +42,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener. == SEE ALSO +[.text-left] <<nng_close.3#,nng_close(3)>>, <<nng_listen.3#,nng_listen(3)>>, <<nng_listener_create.3#,nng_listener_create(3)>> diff --git a/docs/man/nng_listener_create.3.adoc b/docs/man/nng_listener_create.3.adoc index 7ea926c8..059a481f 100644 --- a/docs/man/nng_listener_create.3.adoc +++ b/docs/man/nng_listener_create.3.adoc @@ -58,12 +58,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINVAL`:: An invalid _url_ was specified. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_ENOMEM`:: Insufficient memory is available. == SEE ALSO +[.text-left] <<nng_dialer_create.3#,nng_dialer_create(3)>> <<nng_listen.3#,nng_listen(3)>>, <<nng_listener_close.3#,nng_listener_close(3)>>, diff --git a/docs/man/nng_listener_getopt.3.adoc b/docs/man/nng_listener_getopt.3.adoc index 14cc6a06..74717e5a 100644 --- a/docs/man/nng_listener_getopt.3.adoc +++ b/docs/man/nng_listener_getopt.3.adoc @@ -122,6 +122,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener. `NNG_EINVAL`:: Size of destination _val_ too small for object. @@ -131,6 +132,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_listen.3#,nng_listen(3)>>, <<nng_listener_create.3#,nng_listener_create(3)>> <<nng_listener_setopt.3#,nng_listener_setopt(3)>> diff --git a/docs/man/nng_listener_id.3.adoc b/docs/man/nng_listener_id.3.adoc index 6c3537b0..b0d4c2d2 100644 --- a/docs/man/nng_listener_id.3.adoc +++ b/docs/man/nng_listener_id.3.adoc @@ -47,5 +47,6 @@ None. == SEE ALSO +[.text-left] <<nng_listener.5#,nng_listener(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_listener_setopt.3.adoc b/docs/man/nng_listener_setopt.3.adoc index 99b74124..4c151c76 100644 --- a/docs/man/nng_listener_setopt.3.adoc +++ b/docs/man/nng_listener_setopt.3.adoc @@ -107,6 +107,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener. `NNG_EINVAL`:: The value being passed is invalid. @@ -116,6 +117,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_listen.3#,nng_listen(3)>>, <<nng_listener_create.3#,nng_listener_create(3)>> <<nng_listener_getopt.3#,nng_listener_getopt(3)>> diff --git a/docs/man/nng_listener_start.3.adoc b/docs/man/nng_listener_start.3.adoc index 4b3f9083..94a1e420 100644 --- a/docs/man/nng_listener_start.3.adoc +++ b/docs/man/nng_listener_start.3.adoc @@ -53,11 +53,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: Parameter _l_ does not refer to an open listener. `NNG_ESTATE`:: The listener _l_ is already started. == SEE ALSO +[.text-left] <<nng_listen.3#,nng_listen(3)>>, <<nng_listener_create.3#,nng_listener_create(3)>> <<nng_listener.5#,nng_listener(5)>>, diff --git a/docs/man/nng_msg.5.adoc b/docs/man/nng_msg.5.adoc index 46aa11da..baf6410f 100644 --- a/docs/man/nng_msg.5.adoc +++ b/docs/man/nng_msg.5.adoc @@ -50,10 +50,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. == SEE ALSO +[.text-left] <<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, <<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, diff --git a/docs/man/nng_msg_alloc.3.adoc b/docs/man/nng_msg_alloc.3.adoc index 72cfb306..e164c577 100644 --- a/docs/man/nng_msg_alloc.3.adoc +++ b/docs/man/nng_msg_alloc.3.adoc @@ -35,10 +35,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. == SEE ALSO +[.text-left] <<nng_msg_free.3#,nng_msg_free(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, <<nng_msg_dup.3#,nng_msg_dup(3)>>, diff --git a/docs/man/nng_msg_append.3.adoc b/docs/man/nng_msg_append.3.adoc index 99df4943..7bceb223 100644 --- a/docs/man/nng_msg_append.3.adoc +++ b/docs/man/nng_msg_append.3.adoc @@ -37,10 +37,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, <<nng_msg_chop.3#,nng_msg_chop(3)>>, diff --git a/docs/man/nng_msg_body.3.adoc b/docs/man/nng_msg_body.3.adoc index f2de29a2..af24e976 100644 --- a/docs/man/nng_msg_body.3.adoc +++ b/docs/man/nng_msg_body.3.adoc @@ -34,7 +34,7 @@ Such functions are `<<nng_msg_realloc.3#,nng_msg_realloc()>>`, any of the `<<nng_msg_trim.3#,nng_msg_trim()>>`, `<<nng_msg_chop.3#,nng_msg_chop()>>`, -`<<nng_msg_append.3#,nng_msg_append()>>`, +`<<nng_msg_append.3#,nng_msg_append()>>`, or `<<nng_msg_insert.3#,nng_msg_insert()>>` variants. == RETURN VALUES @@ -47,6 +47,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_append.3#,nng_msg_append(3)>>, <<nng_msg_chop.3#,nng_msg_chop(3)>>, diff --git a/docs/man/nng_msg_chop.3.adoc b/docs/man/nng_msg_chop.3.adoc index 41a4bd22..44f15ac6 100644 --- a/docs/man/nng_msg_chop.3.adoc +++ b/docs/man/nng_msg_chop.3.adoc @@ -27,7 +27,7 @@ int nng_msg_chop_u32(nng_msg *msg, uint32_t *val32); == DESCRIPTION The `nng_msg_chop()` and `nng_msg_chop_u32()` functions remove data from -the end of the body of message _msg_. +the end of the body of message _msg_. The first function removes _size_ bytes. The second function removes 4 bytes, and stores them in the value _val32_, after converting them from network-byte order (big-endian) to native byte order. @@ -38,10 +38,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: The message body is too short to remove the requested data. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_append.3#,nng_msg_append(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, diff --git a/docs/man/nng_msg_clear.3.adoc b/docs/man/nng_msg_clear.3.adoc index 23f940fb..b2f841b1 100644 --- a/docs/man/nng_msg_clear.3.adoc +++ b/docs/man/nng_msg_clear.3.adoc @@ -36,5 +36,6 @@ None. == SEE ALSO +[.text-left] <<nng_msg.5#,nng_msg(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_msg_dup.3.adoc b/docs/man/nng_msg_dup.3.adoc index 2018f9c7..22ca4875 100644 --- a/docs/man/nng_msg_dup.3.adoc +++ b/docs/man/nng_msg_dup.3.adoc @@ -36,10 +36,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to duplicate a message. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_free.3#,nng_msg_free(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_msg_free.3.adoc b/docs/man/nng_msg_free.3.adoc index c329685f..4d110901 100644 --- a/docs/man/nng_msg_free.3.adoc +++ b/docs/man/nng_msg_free.3.adoc @@ -36,6 +36,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_realloc.3#,nng_msg_realloc(3)>>, <<nng_msg.5#,nng_msg(5)>>, diff --git a/docs/man/nng_msg_get_pipe.3.adoc b/docs/man/nng_msg_get_pipe.3.adoc index e12a956c..357d0ec4 100644 --- a/docs/man/nng_msg_get_pipe.3.adoc +++ b/docs/man/nng_msg_get_pipe.3.adoc @@ -53,6 +53,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_set_pipe.3#,nng_msg_set_pipe(3)>>, <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, diff --git a/docs/man/nng_msg_header.3.adoc b/docs/man/nng_msg_header.3.adoc index b4679b0c..80b402ef 100644 --- a/docs/man/nng_msg_header.3.adoc +++ b/docs/man/nng_msg_header.3.adoc @@ -45,6 +45,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, <<nng_msg_free.3#,nng_msg_free(3)>>, diff --git a/docs/man/nng_msg_header_append.3.adoc b/docs/man/nng_msg_header_append.3.adoc index 922f22b5..b711b9f6 100644 --- a/docs/man/nng_msg_header_append.3.adoc +++ b/docs/man/nng_msg_header_append.3.adoc @@ -40,10 +40,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_header.3#,nng_msg_header(3)>>, <<nng_msg_header_chop.3#,nng_msg_header_chop(3)>>, diff --git a/docs/man/nng_msg_header_chop.3.adoc b/docs/man/nng_msg_header_chop.3.adoc index 78625365..6536b6fb 100644 --- a/docs/man/nng_msg_header_chop.3.adoc +++ b/docs/man/nng_msg_header_chop.3.adoc @@ -27,7 +27,7 @@ int nng_msg_header_chop_u32(nng_msg *msg, uint32_t *val32); == DESCRIPTION The `nng_msg_header_chop()` and `nng_msg_header_chop_u32()` functions remove -data from the end of the header of message _msg_. +data from the end of the header of message _msg_. The first function removes _size_ bytes. The second function removes 4 bytes, and stores them in the value _val32_, after converting them from network-byte order (big-endian) to native @@ -39,10 +39,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: The message header is too short to remove the requested data. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_header.3#,nng_msg_header(3)>>, <<nng_msg_header_append.3#,nng_msg_header_append(3)>>, diff --git a/docs/man/nng_msg_header_clear.3.adoc b/docs/man/nng_msg_header_clear.3.adoc index 4402ec40..430dc4d4 100644 --- a/docs/man/nng_msg_header_clear.3.adoc +++ b/docs/man/nng_msg_header_clear.3.adoc @@ -36,6 +36,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_free.3#,nng_msg_free(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_msg_header_insert.3.adoc b/docs/man/nng_msg_header_insert.3.adoc index 89f74b67..f7934738 100644 --- a/docs/man/nng_msg_header_insert.3.adoc +++ b/docs/man/nng_msg_header_insert.3.adoc @@ -38,10 +38,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_header.3#,nng_msg_header(3)>>, <<nng_msg_header_append.3#,nng_msg_header_append(3)>>, diff --git a/docs/man/nng_msg_header_len.3.adoc b/docs/man/nng_msg_header_len.3.adoc index 825df1ba..c6b6a170 100644 --- a/docs/man/nng_msg_header_len.3.adoc +++ b/docs/man/nng_msg_header_len.3.adoc @@ -36,6 +36,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_header.3#,nng_msg_header(3)>>, <<nng_msg.5#,nng_msg(5)>>, diff --git a/docs/man/nng_msg_header_trim.3.adoc b/docs/man/nng_msg_header_trim.3.adoc index dae56184..39d8052e 100644 --- a/docs/man/nng_msg_header_trim.3.adoc +++ b/docs/man/nng_msg_header_trim.3.adoc @@ -27,7 +27,7 @@ int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32); == DESCRIPTION The `nng_msg_header_trim()` and `nng_msg_header_trim_u32()` functions remove -data from the start of the header of message _msg_. +data from the start of the header of message _msg_. The first function removes _size_ bytes. The second function removes 4 bytes, and stores them in the value _val32_, after converting them from network-byte order (big-endian) to native @@ -39,10 +39,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: The message header is too short to remove the requested data. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_header.3#,nng_msg_header(3)>>, <<nng_msg_header_append.3#,nng_msg_header_append(3)>>, diff --git a/docs/man/nng_msg_insert.3.adoc b/docs/man/nng_msg_insert.3.adoc index 7955a2fb..ddc8d46d 100644 --- a/docs/man/nng_msg_insert.3.adoc +++ b/docs/man/nng_msg_insert.3.adoc @@ -16,19 +16,19 @@ nng_msg_insert, nng_msg_insert_u32 - prepend to message body == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> int nng_msg_insert(nng_msg *msg, const void *val, size_t size); int nng_msg_insert(nng_msg *msg, uint32_t val32); ------------ +---- == DESCRIPTION The `nng_msg_insert()` and `nng_msg_insert_u32()` functions prepend data to the front of the body of message _msg_, reallocating it if necessary. -The first function prepends _size_ bytes, copying them from _val_. +The first function prepends _size_ bytes, copying them from _val_. The second function prepends the value _val32_ in network-byte order (big-endian). @@ -43,10 +43,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_append.3#,nng_msg_append(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, diff --git a/docs/man/nng_msg_len.3.adoc b/docs/man/nng_msg_len.3.adoc index e181aa20..41f1cc64 100644 --- a/docs/man/nng_msg_len.3.adoc +++ b/docs/man/nng_msg_len.3.adoc @@ -36,6 +36,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, <<nng_msg.5#,nng_msg(5)>>, diff --git a/docs/man/nng_msg_realloc.3.adoc b/docs/man/nng_msg_realloc.3.adoc index b1308fff..03a2494d 100644 --- a/docs/man/nng_msg_realloc.3.adoc +++ b/docs/man/nng_msg_realloc.3.adoc @@ -48,10 +48,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to reallocate a message. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_append.3#,nng_msg_append(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, diff --git a/docs/man/nng_msg_set_pipe.3.adoc b/docs/man/nng_msg_set_pipe.3.adoc index 68ca9305..e63170a6 100644 --- a/docs/man/nng_msg_set_pipe.3.adoc +++ b/docs/man/nng_msg_set_pipe.3.adoc @@ -42,6 +42,7 @@ None. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_get_pipe.3#,nng_msg_get_pipe(3)>>, <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, diff --git a/docs/man/nng_msg_trim.3.adoc b/docs/man/nng_msg_trim.3.adoc index e371ff0a..a599b13c 100644 --- a/docs/man/nng_msg_trim.3.adoc +++ b/docs/man/nng_msg_trim.3.adoc @@ -27,7 +27,7 @@ int nng_msg_trim_u32(nng_msg *msg, uint32_t *val32); == DESCRIPTION The `nng_msg_trim()` and `nng_msg_trim_u32()` functions remove data from -the start of the body of message _msg_. +the start of the body of message _msg_. The first function removes _size_ bytes. The second function removes 4 bytes, and stores them in the value _val32_, after converting them from network-byte order (big-endian) to native @@ -39,10 +39,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: The message body is too short to remove the requested data. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_append.3#,nng_msg_append(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, diff --git a/docs/man/nng_msleep.3supp.adoc b/docs/man/nng_msleep.3supp.adoc index f3e7f25c..c1e3ff64 100644 --- a/docs/man/nng_msleep.3supp.adoc +++ b/docs/man/nng_msleep.3supp.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_sleep_aio.3#,nng_sleep_aio(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, <<nng_clock.3supp#,nng_clock(3supp)>>, diff --git a/docs/man/nng_mtx_alloc.3supp.adoc b/docs/man/nng_mtx_alloc.3supp.adoc index ba4e0c06..3a327338 100644 --- a/docs/man/nng_mtx_alloc.3supp.adoc +++ b/docs/man/nng_mtx_alloc.3supp.adoc @@ -44,10 +44,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_mtx_free.3supp#,nng_mtx_free(3supp)>>, <<nng_mtx_lock.3supp#,nng_mtx_lock(3supp)>>, diff --git a/docs/man/nng_mtx_free.3supp.adoc b/docs/man/nng_mtx_free.3supp.adoc index f0cb44de..e30e861f 100644 --- a/docs/man/nng_mtx_free.3supp.adoc +++ b/docs/man/nng_mtx_free.3supp.adoc @@ -38,5 +38,6 @@ None. == SEE ALSO +[.text-left] <<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_mtx_lock.3supp.adoc b/docs/man/nng_mtx_lock.3supp.adoc index 8ea4bdd6..6a0c5006 100644 --- a/docs/man/nng_mtx_lock.3supp.adoc +++ b/docs/man/nng_mtx_lock.3supp.adoc @@ -40,7 +40,7 @@ It is a programming error for the owner of a mutex to attempt to reacquire it. **** -_nng_ offers neither a "`trylock`" operation, nor recursive mutexes. +_nng_ offers neither a "`trylock`" operation, nor recursive mutexes. This is by design, as _nng_ itself does not use such things, and most often the need for them is the result of poor design. If such capabilities are needed, they may be synthesized fairly @@ -57,6 +57,7 @@ None. == SEE ALSO +[.text-left] <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, <<nng_mtx_unlock.3supp#,nng_mtx_unlock(3supp)>>, diff --git a/docs/man/nng_mtx_unlock.3supp.adoc b/docs/man/nng_mtx_unlock.3supp.adoc index 996908d3..e0742a55 100644 --- a/docs/man/nng_mtx_unlock.3supp.adoc +++ b/docs/man/nng_mtx_unlock.3supp.adoc @@ -42,6 +42,7 @@ None. == SEE ALSO +[.text-left] <<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, <<nng_mtx_lock.3supp#,nng_mtx_lock(3supp)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_options.5.adoc b/docs/man/nng_options.5.adoc index 37492ce4..6a155953 100644 --- a/docs/man/nng_options.5.adoc +++ b/docs/man/nng_options.5.adoc @@ -344,6 +344,7 @@ middleware from being expiring due to lack of activity. == SEE ALSO +[.text-left] <<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>, <<nng_dialer_setopt.3#,nng_dialer_setopt(3)>>, <<nng_getopt.3#,nng_getopt(3)>>, diff --git a/docs/man/nng_opts_parse.3supp.adoc b/docs/man/nng_opts_parse.3supp.adoc index 6fc22a7f..c932d514 100644 --- a/docs/man/nng_opts_parse.3supp.adoc +++ b/docs/man/nng_opts_parse.3supp.adoc @@ -24,7 +24,7 @@ typedef struct nng_optspec { const char *o_name; // Long style name (may be NULL for short only) int o_short; // Short option (no clustering!) int o_val; // Value stored on a good parse (>0) - bool o_arg; // Option takes an argument if true + bool o_arg; // Option takes an argument if true } nng_optspec; int nng_opts_parse(int argc, const char **argv, const nng_optspec *spec, int *val, const char **arg, int *idx); @@ -94,7 +94,7 @@ This structure has the following members: === Long Options Long options are parsed from the _argv_ array, and are indicated when -the element being scanned starts with two dashes. +the element being scanned starts with two dashes. For example, the "verbose" option would be specified as `--verbose` on the command line. If a long option takes an argument, it can either immediately follow @@ -173,11 +173,13 @@ no more options are available to be parsed, or an error number otherwise. == ERRORS +[horizontal] `NNG_EAMBIGUOUS`:: Parsed option matches more than one specification. `NNG_ENOARG`:: Option requires an argument, but one is not present. `NNG_EINVAL`:: An invalid (unknown) argument is present. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pair.7.adoc b/docs/man/nng_pair.7.adoc index 3d070d00..7d5fd435 100644 --- a/docs/man/nng_pair.7.adoc +++ b/docs/man/nng_pair.7.adoc @@ -34,8 +34,8 @@ The ((_pair_ protocol)) implements a peer-to-peer pattern, where relationships between peers are one-to-one. Version 1 of this protocol supports an optional ((_polyamorous_ mode)) where a -peer can maintain multiple partnerships. Using this mode requires -some additional sophistication in the application. +peer can maintain multiple partnerships. +Using this mode requires some additional sophistication in the application. === Socket Operations @@ -121,9 +121,10 @@ used in conjuction with the device forwarding loops. This value is initialized to 1, and incremented each time the message is received by a new node. - + == SEE ALSO +[.text-left] <<nng_pair_open.3#,nng_pair_open(3)>>, <<nng_options.5#,nng_options(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pair_open.3.adoc b/docs/man/nng_pair_open.3.adoc index 054c3ffc..dd52fca9 100644 --- a/docs/man/nng_pair_open.3.adoc +++ b/docs/man/nng_pair_open.3.adoc @@ -52,11 +52,13 @@ These functions returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_pair.7#,nng_pair(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pipe.5.adoc b/docs/man/nng_pipe.5.adoc index cf11c047..39807a84 100644 --- a/docs/man/nng_pipe.5.adoc +++ b/docs/man/nng_pipe.5.adoc @@ -28,7 +28,7 @@ typedef struct nng_pipe_s nng_pipe; An `nng_pipe` is a handle to a "`pipe`", which can be thought of as a single connection. (In most cases this is actually the case -- the pipe is an abstraction for a -single TCP or IPC connection.) +single TCP or IPC connection.) Pipes are associated with either the listener or dialer that created them, and therefore are also automatically associated with a single socket. @@ -37,7 +37,7 @@ for input parameters and return values), and should be treated opaquely. Passing structures this way ensures gives the compiler a chance to perform accurate type checks in functions passing values of this type. -TIP: Most applications should never concern themselves with individual pipes. +TIP: Most applications should never concern themselves with individual pipes. However it is possible to access a pipe when more information about the source of a message is needed, or when more control is required over message delivery. @@ -66,6 +66,7 @@ nng_pipe p = NNG_PIPE_INITIALIZER; == SEE ALSO +[.text-left] <<nng_msg_get_pipe.3#,nng_msg_get_pipe(3)>>, <<nng_pipe_close.3#,nng_pipe_close(3)>>, <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, diff --git a/docs/man/nng_pipe_close.3.adoc b/docs/man/nng_pipe_close.3.adoc index 5e8cb851..ea11c1d6 100644 --- a/docs/man/nng_pipe_close.3.adoc +++ b/docs/man/nng_pipe_close.3.adoc @@ -41,10 +41,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: The pipe _p_ is already closed or was never opened. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_options.5#,nng_options(5)>>, <<nng_pipe.5#,nng_pipe(5)>>, diff --git a/docs/man/nng_pipe_dialer.3.adoc b/docs/man/nng_pipe_dialer.3.adoc index 476ab1be..ede04a4d 100644 --- a/docs/man/nng_pipe_dialer.3.adoc +++ b/docs/man/nng_pipe_dialer.3.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_pipe.5#,nng_pipe(5)>>, <<nng_dialer.5#,nng_dialer(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pipe_getopt.3.adoc b/docs/man/nng_pipe_getopt.3.adoc index 64cad9a3..e4eb5223 100644 --- a/docs/man/nng_pipe_getopt.3.adoc +++ b/docs/man/nng_pipe_getopt.3.adoc @@ -137,6 +137,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EBADTYPE`:: Incorrect type for option. `NNG_ECLOSED`:: Parameter _p_ does not refer to an open pipe. `NNG_ENOTSUP`:: The option _opt_ is not supported. @@ -146,6 +147,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dialer_setopt.3#,nng_dialer_setopt(3)>> <<nng_getopt.3#,nng_getopt(3)>>, <<nng_listener_setopt.3#,nng_listener_setopt(3)>> diff --git a/docs/man/nng_pipe_id.3.adoc b/docs/man/nng_pipe_id.3.adoc index 19eed4f6..5cf821f0 100644 --- a/docs/man/nng_pipe_id.3.adoc +++ b/docs/man/nng_pipe_id.3.adoc @@ -45,5 +45,6 @@ None. == SEE ALSO +[.text-left] <<nng_pipe.5#,nng_pipe(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pipe_listener.3.adoc b/docs/man/nng_pipe_listener.3.adoc index 3b7db4d6..11246cab 100644 --- a/docs/man/nng_pipe_listener.3.adoc +++ b/docs/man/nng_pipe_listener.3.adoc @@ -41,6 +41,7 @@ None. == SEE ALSO +[.text-left] <<nng_pipe.5#,nng_pipe(5)>>, <<nng_listener.5#,nng_listener(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pipe_notify.3.adoc b/docs/man/nng_pipe_notify.3.adoc index 0a8785e3..314faebd 100644 --- a/docs/man/nng_pipe_notify.3.adoc +++ b/docs/man/nng_pipe_notify.3.adoc @@ -75,10 +75,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: The socket _s_ does not refer to an open socket. == SEE ALSO +[.text-left] <<nng_pipe_close.3#,nng_pipe_close(3)>>, <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, <<nng_pipe.5#,nng_pipe(5)>>, diff --git a/docs/man/nng_pipe_socket.3.adoc b/docs/man/nng_pipe_socket.3.adoc index f2d02aa3..ec523718 100644 --- a/docs/man/nng_pipe_socket.3.adoc +++ b/docs/man/nng_pipe_socket.3.adoc @@ -40,6 +40,7 @@ None. == SEE ALSO +[.text-left] <<nng_pipe.5#,nng_pipe(5)>>, <<nng_socket.5#,nng_socket(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pub.7.adoc b/docs/man/nng_pub.7.adoc index 6aec8c9e..5a274511 100644 --- a/docs/man/nng_pub.7.adoc +++ b/docs/man/nng_pub.7.adoc @@ -60,9 +60,10 @@ The _pub_ protocol has no protocol-specific options. === Protocol Headers The _pub_ protocol has no protocol-specific headers. - + == SEE ALSO +[.text-left] <<nng_pub_open.3#,nng_pub_open(3)>>, <<nng_sub.7#,nng_sub(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_pub_open.3.adoc b/docs/man/nng_pub_open.3.adoc index 32655b1d..3aa02a5c 100644 --- a/docs/man/nng_pub_open.3.adoc +++ b/docs/man/nng_pub_open.3.adoc @@ -40,11 +40,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_pub.7#,nng_pub(7)>>, <<nng_sub.7#,nng_sub(7)>>, diff --git a/docs/man/nng_pull.7.adoc b/docs/man/nng_pull.7.adoc index 59607e7e..558c39e8 100644 --- a/docs/man/nng_pull.7.adoc +++ b/docs/man/nng_pull.7.adoc @@ -26,7 +26,7 @@ nng_pull - pull protocol The ((_pull_ protocol)) is one half of a ((pipeline pattern)). The other half is the <<nng_push.7#,_push_>> protocol. -In the pipeline pattern, pushers distribute messages to pullers. +In the pipeline pattern, pushers distribute messages to pullers. Each message sent by a pusher will be sent to one of its peer pullers, chosen in a round-robin fashion @@ -56,9 +56,10 @@ The _pull_ protocol has no protocol-specific options. === Protocol Headers The _pull_ protocol has no protocol-specific headers. - + == SEE ALSO +[.text-left] <<nng_pull_open.3#,nng_pull_open(3)>>, <<nng_push.7#,nng_push(7)>>, <<nng.7#,nng(7)>>, diff --git a/docs/man/nng_pull_open.3.adoc b/docs/man/nng_pull_open.3.adoc index 1fd7eac4..a365faa3 100644 --- a/docs/man/nng_pull_open.3.adoc +++ b/docs/man/nng_pull_open.3.adoc @@ -40,11 +40,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_pull.7#,nng_pull(7)>>, <<nng_push.7#,nng_push(7)>>, diff --git a/docs/man/nng_push.7.adoc b/docs/man/nng_push.7.adoc index 800c0bd6..bff41e89 100644 --- a/docs/man/nng_push.7.adoc +++ b/docs/man/nng_push.7.adoc @@ -26,7 +26,7 @@ nng_push - push protocol The ((_push_ protocol)) is one half of a ((pipeline pattern)). The other side is the <<nng_pull.7#,_pull_>> protocol. -In the pipeline pattern, pushers distribute messages to pullers. +In the pipeline pattern, pushers distribute messages to pullers. Each message sent by a pusher will be sent to one of its peer pullers, chosen in a round-robin fashion from the set of connected peers available for receiving. @@ -61,9 +61,10 @@ The _push_ protocol has no protocol-specific options. === Protocol Headers The _push_ protocol has no protocol-specific headers. - + == SEE ALSO +[.text-left] <<nng_push_open.3#,nng_push(3)>>, <<nng_pull.7#,nng_pull(7)>>, <<nng_req.7#,nng_req(7)>>, diff --git a/docs/man/nng_push_open.3.adoc b/docs/man/nng_push_open.3.adoc index 1769b2f2..43fef86f 100644 --- a/docs/man/nng_push_open.3.adoc +++ b/docs/man/nng_push_open.3.adoc @@ -40,11 +40,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_pull.7#,nng_pull(7)>>, <<nng_push.7#,nng_push(7)>>, diff --git a/docs/man/nng_random.3supp.adoc b/docs/man/nng_random.3supp.adoc index 9003fea8..424ad32b 100644 --- a/docs/man/nng_random.3supp.adoc +++ b/docs/man/nng_random.3supp.adoc @@ -41,4 +41,5 @@ None. == SEE ALSO +[.text-left] <<nng.7#,nng(7)>> diff --git a/docs/man/nng_recv.3.adoc b/docs/man/nng_recv.3.adoc index 5ab180f0..f7c5f239 100644 --- a/docs/man/nng_recv.3.adoc +++ b/docs/man/nng_recv.3.adoc @@ -64,6 +64,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EAGAIN`:: The socket _s_ cannot accept data for sending. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_EINVAL`:: An invalid set of _flags_ was specified. @@ -74,6 +75,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_alloc.3#,nng_alloc(3)>>, <<nng_free.3#,nng_free(3)>>, <<nng_recvmsg.3#,nng_recvmsg(3)>>, diff --git a/docs/man/nng_recv_aio.3.adoc b/docs/man/nng_recv_aio.3.adoc index 774577bf..e10149ac 100644 --- a/docs/man/nng_recv_aio.3.adoc +++ b/docs/man/nng_recv_aio.3.adoc @@ -60,6 +60,7 @@ None. (The operation completes asynchronously.) == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was aborted. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_ENOMEM`:: Insufficient memory is available. @@ -69,6 +70,7 @@ None. (The operation completes asynchronously.) == SEE ALSO +[.text-left] <<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, <<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, diff --git a/docs/man/nng_recvmsg.3.adoc b/docs/man/nng_recvmsg.3.adoc index abe7c723..8876c716 100644 --- a/docs/man/nng_recvmsg.3.adoc +++ b/docs/man/nng_recvmsg.3.adoc @@ -16,11 +16,11 @@ nng_recvmsg - recv message == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> int nng_recvmsg(nng_socket s, nng_msg **msgp, int flags); ------------ +---- == DESCRIPTION @@ -51,6 +51,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EAGAIN`:: The socket _s_ cannot accept data for sending. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_EINVAL`:: An invalid set of _flags_ was specified. @@ -60,6 +61,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_msg_free.3#,nng_msg_free(3)>>, <<nng_recv.3#,nng_recv(3)>>, <<nng_sendmsg.3#,nng_sendmsg(3)>>, diff --git a/docs/man/nng_rep.7.adoc b/docs/man/nng_rep.7.adoc index 962056be..f822849f 100644 --- a/docs/man/nng_rep.7.adoc +++ b/docs/man/nng_rep.7.adoc @@ -77,9 +77,10 @@ The _rep_ protocol has no protocol-specific options. (((backtrace))) The _rep_ protocol uses a _backtrace_ in the header. This is more fully documented in the <<nng_req.7#,_req_>> manual. - + == SEE ALSO +[.text-left] <<nng_rep_open.3#,nng_rep_open(3)>>, <<nng.7#,nng(7)>>, <<nng_req.7#,nng_req(7)>> diff --git a/docs/man/nng_rep_open.3.adoc b/docs/man/nng_rep_open.3.adoc index f90cefe2..2bebc490 100644 --- a/docs/man/nng_rep_open.3.adoc +++ b/docs/man/nng_rep_open.3.adoc @@ -38,11 +38,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_rep.7#,nng_rep(7)>>, <<nng_req.7#,nng_req(7)>>, diff --git a/docs/man/nng_req.7.adoc b/docs/man/nng_req.7.adoc index 282c1db5..42abe843 100644 --- a/docs/man/nng_req.7.adoc +++ b/docs/man/nng_req.7.adoc @@ -146,6 +146,7 @@ request ID it originally used for the request. == SEE ALSO +[.text-left] <<nng_ctx_open.3#,nng_ctx_open(3)>>, <<nng_device.3#,nng_device(3)>>, <<nng_req_open.3#,nng_req_open(3)>>, diff --git a/docs/man/nng_req_open.3.adoc b/docs/man/nng_req_open.3.adoc index dd2e7cb6..1f92159a 100644 --- a/docs/man/nng_req_open.3.adoc +++ b/docs/man/nng_req_open.3.adoc @@ -41,11 +41,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_options.5#,nng_options(5)>>, <<nng_socket.5#,nng_socket(5)>>, <<nng_rep.7#,nng_rep(7)>>, diff --git a/docs/man/nng_respondent.7.adoc b/docs/man/nng_respondent.7.adoc index b03fa75f..a2208004 100644 --- a/docs/man/nng_respondent.7.adoc +++ b/docs/man/nng_respondent.7.adoc @@ -45,7 +45,7 @@ This socket may be used to receive messages, and then to send replies. A reply can only be sent after receiving a survey, and generally the reply will be sent to surveyor from whom the last survey was received. -Respondents may discard a survey by simply not replying to it. +Respondents may discard a survey by simply not replying to it. Raw mode sockets (set with `<<nng_options.5#NNG_OPT_RAW,NNG_OPT_RAW>>`) ignore all these restrictions. @@ -85,6 +85,7 @@ This is more fully documented in the <<nng_surveyor.7#,_surveyor_>> manual. == SEE ALSO +[.text-left] <<nng_respondent_open.3#,nng_respondent_open(3)>>, <<nng_surveyor.7#,nng_surveyor(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_respondent_open.3.adoc b/docs/man/nng_respondent_open.3.adoc index 33e9904f..65122680 100644 --- a/docs/man/nng_respondent_open.3.adoc +++ b/docs/man/nng_respondent_open.3.adoc @@ -43,11 +43,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_respondent.7#,nng_respondent(7)>>, <<nng_surveyor.7#,nng_surveyor(7)>>, diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc index 7a1ed0fb..20d3ae4d 100644 --- a/docs/man/nng_send.3.adoc +++ b/docs/man/nng_send.3.adoc @@ -78,6 +78,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EAGAIN`:: The socket _s_ cannot accept data for sending. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_EINVAL`:: An invalid set of _flags_ was specified. @@ -88,6 +89,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_alloc.3#,nng_alloc(3)>>, <<nng_free.3#,nng_free(3)>>, <<nng_recv.3#,nng_recv(3)>>, diff --git a/docs/man/nng_send_aio.3.adoc b/docs/man/nng_send_aio.3.adoc index 47f9df14..c82d1a79 100644 --- a/docs/man/nng_send_aio.3.adoc +++ b/docs/man/nng_send_aio.3.adoc @@ -69,6 +69,7 @@ None. (The operation completes asynchronously.) == ERRORS +[horizontal] `NNG_ECANCELED`:: The operation was aborted. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_EMSGSIZE`:: The message is too large. @@ -79,6 +80,7 @@ None. (The operation completes asynchronously.) == SEE ALSO +[.text-left] <<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, <<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, diff --git a/docs/man/nng_sendmsg.3.adoc b/docs/man/nng_sendmsg.3.adoc index dffb042f..f3f2992c 100644 --- a/docs/man/nng_sendmsg.3.adoc +++ b/docs/man/nng_sendmsg.3.adoc @@ -24,7 +24,7 @@ int nng_sendmsg(nng_socket s, nng_msg *msg, int flags); == DESCRIPTION -The `nng_sendmsg()` sends message _msg_ using the socket _s_. +The `nng_sendmsg()` sends message _msg_ using the socket _s_. If the function returns zero, indicating it has accepted the message for delivery, then the _msg_ is "`owned`" by the socket _s_, and the caller @@ -72,6 +72,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EAGAIN`:: The socket _s_ cannot accept data for sending. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_EINVAL`:: An invalid set of _flags_ was specified. @@ -82,6 +83,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_recvmsg.3#,nng_recvmsg(3)>>, <<nng_send.3#,nng_send(3)>>, diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc index d54b7f27..40bb820a 100644 --- a/docs/man/nng_setopt.3.adoc +++ b/docs/man/nng_setopt.3.adoc @@ -104,6 +104,7 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket. `NNG_EINVAL`:: The value being passed is invalid. `NNG_ENOTSUP`:: The option _opt_ is not supported. @@ -112,6 +113,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_getopt.3#,nng_getopt(3)>>, <<nng_dialer_setopt.3#,nng_dialer_setopt(3)>>, <<nng_listener_setopt.3#,nng_listener_setopt(3)>>, diff --git a/docs/man/nng_sleep_aio.3.adoc b/docs/man/nng_sleep_aio.3.adoc index c243d6bc..6592b7b0 100644 --- a/docs/man/nng_sleep_aio.3.adoc +++ b/docs/man/nng_sleep_aio.3.adoc @@ -43,6 +43,7 @@ None. == SEE ALSO +[.text-left] <<nng_aio_abort.3#,nng_aio_abort(3)>>, <<nng_aio_alloc.3#,nng_aio_alloc(3)>>, <<nng_aio_set_timeout.3#,nng_aio_set_timeout(3)>>, diff --git a/docs/man/nng_sockaddr.5.adoc b/docs/man/nng_sockaddr.5.adoc index 595f3116..7d595c22 100644 --- a/docs/man/nng_sockaddr.5.adoc +++ b/docs/man/nng_sockaddr.5.adoc @@ -34,7 +34,7 @@ enum sockaddr_family { NNG_AF_IPC = 2, NNG_AF_INET = 3, NNG_AF_INET6 = 4, - NNG_AF_ZT = 5, + NNG_AF_ZT = 5, }; ---- @@ -63,28 +63,19 @@ specific member should be used. The values of `s_family` are as follows: -`NNG_AF_UNSPEC`:: - Invalid address, no other valid fields. -`NNG_AF_INPROC`:: - Address for intraprocess communication (<<nng_inproc.7#,nng_inproc(7)>>). - The `s_inproc` member is valid. -`NNG_AF_IPC`:: - Address for interprocess communication (<<nng_ipc.7#,nng_ipc(7)>>). - The `s_path` member is valid. -`NNG_AF_INET`:: - Address for TCP/IP (v4) communication. - The `s_in` member is valid. -`NNG_AF_INET6`:: - Address for TCP/IP (v6) communication. - The `s_in6` member is valid. -`NNG_AF_ZT`:: - Address for ZeroTier transport (<<nng_zerotier.7#,nng_zerotier(7)>>). - The `s_zt` member is valid. +[horizontal] +`NNG_AF_UNSPEC`:: Invalid address, no other valid fields. +`NNG_AF_INPROC`:: Address for intraprocess communication (<<nng_inproc.7#,nng_inproc(7)>>). The `s_inproc` member is valid. +`NNG_AF_IPC`:: Address for interprocess communication (<<nng_ipc.7#,nng_ipc(7)>>). The `s_path` member is valid. +`NNG_AF_INET`:: Address for TCP/IP (v4) communication. The `s_in` member is valid. +`NNG_AF_INET6`:: Address for TCP/IP (v6) communication. The `s_in6` member is valid. +`NNG_AF_ZT`:: Address for ZeroTier transport (<<nng_zerotier.7#,nng_zerotier(7)>>). The `s_zt` member is valid. Please see the manual pages for each individual type for more information. == SEE ALSO +[.text-left] <<nng_sockaddr_in.5#,nng_sockaddr_in(5)>>, <<nng_sockaddr_in6.5#,nng_sockaddr_in6(5)>>, <<nng_sockaddr_inproc.5#,nng_sockaddr_inproc(5)>>, diff --git a/docs/man/nng_sockaddr_in.5.adoc b/docs/man/nng_sockaddr_in.5.adoc index 5dcc02c6..d47f77d4 100644 --- a/docs/man/nng_sockaddr_in.5.adoc +++ b/docs/man/nng_sockaddr_in.5.adoc @@ -64,6 +64,7 @@ _not_ the same, and they may not be used interchangeabley. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_sockaddr_in6.5#,nng_sockaddr_in6(5)>>, <<nng_tcp.7#,nng_tcp(7)>>, diff --git a/docs/man/nng_sockaddr_in6.5.adoc b/docs/man/nng_sockaddr_in6.5.adoc index 6ac809ba..2d2a8a8b 100644 --- a/docs/man/nng_sockaddr_in6.5.adoc +++ b/docs/man/nng_sockaddr_in6.5.adoc @@ -64,6 +64,7 @@ _not_ the same, and they may not be used interchangeabley. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_sockaddr_in.5#,nng_sockaddr_in(5)>>, <<nng_tcp.7#,nng_tcp(7)>>, diff --git a/docs/man/nng_sockaddr_inproc.5.adoc b/docs/man/nng_sockaddr_inproc.5.adoc index c7901c63..428ddc1b 100644 --- a/docs/man/nng_sockaddr_inproc.5.adoc +++ b/docs/man/nng_sockaddr_inproc.5.adoc @@ -53,6 +53,7 @@ Furthermore, the size is guaranteed to be at least 128. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_inproc.7#,nng_inproc(7)>> <<nng.7#,nng(7)>> diff --git a/docs/man/nng_sockaddr_ipc.5.adoc b/docs/man/nng_sockaddr_ipc.5.adoc index 3fac561b..8e598144 100644 --- a/docs/man/nng_sockaddr_ipc.5.adoc +++ b/docs/man/nng_sockaddr_ipc.5.adoc @@ -65,6 +65,7 @@ longer than 128 bytes, including the `ipc://` prefix. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_ipc.7#,nng_ipc(7)>> <<nng.7#,nng(7)>> diff --git a/docs/man/nng_sockaddr_zt.5.adoc b/docs/man/nng_sockaddr_zt.5.adoc index e601e974..9491823e 100644 --- a/docs/man/nng_sockaddr_zt.5.adoc +++ b/docs/man/nng_sockaddr_zt.5.adoc @@ -76,6 +76,7 @@ the Scalability Protocols binding for them. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_zerotier.7#,nng_zerotier(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_socket.5.adoc b/docs/man/nng_socket.5.adoc index 35a6a3c6..f0aad0c6 100644 --- a/docs/man/nng_socket.5.adoc +++ b/docs/man/nng_socket.5.adoc @@ -59,6 +59,7 @@ nng_socket s = NNG_SOCKET_INITIALIZER; == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng_close.3#,nng_close(3)>>, <<nng_getopt.3#,nng_getopt(3)>>, diff --git a/docs/man/nng_socket_id.3.adoc b/docs/man/nng_socket_id.3.adoc index 163ab2ed..30a59bec 100644 --- a/docs/man/nng_socket_id.3.adoc +++ b/docs/man/nng_socket_id.3.adoc @@ -46,5 +46,6 @@ None. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_strdup.3.adoc b/docs/man/nng_strdup.3.adoc index 6efacc37..24a56ada 100644 --- a/docs/man/nng_strdup.3.adoc +++ b/docs/man/nng_strdup.3.adoc @@ -50,6 +50,7 @@ treated the same as `NNG_ENOMEM`. == SEE ALSO +[.text-left] <<nng_alloc.3#,nng_alloc(3)>>, <<nng_free.3#,nng_free(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_strerror.3.adoc b/docs/man/nng_strerror.3.adoc index 28ff85a4..c8de5ecd 100644 --- a/docs/man/nng_strerror.3.adoc +++ b/docs/man/nng_strerror.3.adoc @@ -43,5 +43,6 @@ by a `NUL` byte. == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_strfree.3.adoc b/docs/man/nng_strfree.3.adoc index 9b91306f..e1d6617e 100644 --- a/docs/man/nng_strfree.3.adoc +++ b/docs/man/nng_strfree.3.adoc @@ -51,6 +51,7 @@ None. == SEE ALSO +[.text-left] <<nng_alloc.3#,nng_alloc(3)>>, <<nng_free.3#,nng_free(3)>>, <<nng_strdup.3#,nng_strdup(3)>>, diff --git a/docs/man/nng_sub.7.adoc b/docs/man/nng_sub.7.adoc index 904f844e..9ff751ca 100644 --- a/docs/man/nng_sub.7.adoc +++ b/docs/man/nng_sub.7.adoc @@ -76,9 +76,10 @@ TIP: To receive all messages, an empty topic (zero length) can be used. === Protocol Headers The _sub_ protocol has no protocol-specific headers. - + == SEE ALSO +[.text-left] <<nng_sub_open.3#,nng_sub_open(3)>>, <<nng_pub.7#,nng_pub(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_sub_open.3.adoc b/docs/man/nng_sub_open.3.adoc index 0e7263dd..2f632fd9 100644 --- a/docs/man/nng_sub_open.3.adoc +++ b/docs/man/nng_sub_open.3.adoc @@ -40,11 +40,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_pub.7#,nng_pub(7)>>, <<nng_sub.7#,nng_sub(7)>>, diff --git a/docs/man/nng_surveyor.7.adoc b/docs/man/nng_surveyor.7.adoc index 69936748..41ce8fe0 100644 --- a/docs/man/nng_surveyor.7.adoc +++ b/docs/man/nng_surveyor.7.adoc @@ -96,7 +96,7 @@ The following protocol-specific options is available. This read/write option is an `<<nng_duration.5#,nng_duration>>` representing a postive number of milliseconds that following surveys - will last. + will last. When a new survey is started, a timer of this duration is also started. Any responses arriving this time will be discarded. Attempts to receive @@ -143,6 +143,7 @@ survey ID it originally used for the request. == SEE ALSO +[.text-left] <<nng_surveyor_open.3#,nng_surveyor_open(3)>>, <<nng_respondent.7#,nng_respondent(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_surveyor_open.3.adoc b/docs/man/nng_surveyor_open.3.adoc index 0ca95d90..f2b357b3 100644 --- a/docs/man/nng_surveyor_open.3.adoc +++ b/docs/man/nng_surveyor_open.3.adoc @@ -41,11 +41,13 @@ These functions return 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The protocol is not supported. == SEE ALSO +[.text-left] <<nng_socket.5#,nng_socket(5)>>, <<nng_respondent.7#,nng_respondent(7)>>, <<nng_surveyor.7#,nng_surveyor(7)>>, diff --git a/docs/man/nng_tcp.7.adoc b/docs/man/nng_tcp.7.adoc index 7b9b6823..250e9399 100644 --- a/docs/man/nng_tcp.7.adoc +++ b/docs/man/nng_tcp.7.adoc @@ -113,6 +113,7 @@ The value is of type `bool` and defaults to `true`. == SEE ALSO +[.text-left] <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_sockaddr_in.5#,nng_sockaddr_in(5)>>, <<nng_sockaddr_in6.5#,nng_sockaddr_in6(5)>>, diff --git a/docs/man/nng_tcp_register.3.adoc b/docs/man/nng_tcp_register.3.adoc index 44005554..fe199de4 100644 --- a/docs/man/nng_tcp_register.3.adoc +++ b/docs/man/nng_tcp_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_tcp.7#,nng_tcp(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_thread_create.3supp.adoc b/docs/man/nng_thread_create.3supp.adoc index b458cf96..63906b39 100644 --- a/docs/man/nng_thread_create.3supp.adoc +++ b/docs/man/nng_thread_create.3supp.adoc @@ -73,10 +73,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, <<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, diff --git a/docs/man/nng_thread_destroy.3supp.adoc b/docs/man/nng_thread_destroy.3supp.adoc index b58c623b..788a3495 100644 --- a/docs/man/nng_thread_destroy.3supp.adoc +++ b/docs/man/nng_thread_destroy.3supp.adoc @@ -42,5 +42,6 @@ None. == SEE ALSO +[.text-left] <<nng_thread_create.3supp#,nng_thread_create(3supp)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc index e2465377..78a87b86 100644 --- a/docs/man/nng_tls.7.adoc +++ b/docs/man/nng_tls.7.adoc @@ -182,6 +182,7 @@ results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`. == SEE ALSO +[.text-left] <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>> <<nng_sockaddr_in.5#,nng_sockaddr_in(5)>>, <<nng_sockaddr_in6.5#,nng_sockaddr_in6(5)>>, diff --git a/docs/man/nng_tls_config_alloc.3tls.adoc b/docs/man/nng_tls_config_alloc.3tls.adoc index 38d068ee..3c898383 100644 --- a/docs/man/nng_tls_config_alloc.3tls.adoc +++ b/docs/man/nng_tls_config_alloc.3tls.adoc @@ -16,17 +16,17 @@ nng_tls_config_alloc - allocate TLS configuration object == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/tls/tls.h> typedef enum nng_tls_mode { - NNG_TLS_MODE_CLIENT, - NNG_TLS_MODE_SERVER + NNG_TLS_MODE_CLIENT, + NNG_TLS_MODE_SERVER } nng_tls_mode; int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); ------------ +---- == DESCRIPTION @@ -59,11 +59,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EINVAL`:: An invalid _mode_ was specified. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode(3tls)>>, <<nng_tls_config_ca_chain.3tls#,nng_tls_config_ca_chain(3tls)>>, diff --git a/docs/man/nng_tls_config_auth_mode.3tls.adoc b/docs/man/nng_tls_config_auth_mode.3tls.adoc index 4a790130..edd4235b 100644 --- a/docs/man/nng_tls_config_auth_mode.3tls.adoc +++ b/docs/man/nng_tls_config_auth_mode.3tls.adoc @@ -16,7 +16,7 @@ nng_tls_config_auth_mode - configure authentication mode == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/tls/tls.h> @@ -27,7 +27,7 @@ typedef enum nng_tls_auth_mode { } nng_tls_auth_mode; int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode); ------------ +---- == DESCRIPTION @@ -48,7 +48,7 @@ then the sesssion is allowed to proceed without authentication. ((`NNG_TLS_AUTH_MODE_REQUIRED`)):: A check is made to ensure that the peer has presented a valid certificate -used for the session. +used for the session. If the peer's certificate is invalid or missing, then the session is refused. This is the default for clients. @@ -58,6 +58,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EINVAL`:: An invalid _mode_ was specified. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. @@ -65,6 +66,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_tls_config_ca_chain.3tls#,nng_tls_config_ca_chain(3tls)>>, diff --git a/docs/man/nng_tls_config_ca_chain.3tls.adoc b/docs/man/nng_tls_config_ca_chain.3tls.adoc index 2c105662..6930bbad 100644 --- a/docs/man/nng_tls_config_ca_chain.3tls.adoc +++ b/docs/man/nng_tls_config_ca_chain.3tls.adoc @@ -50,12 +50,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. `NNG_EINVAL`:: An invalid _chain_ or _crl_ was supplied. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(.3tls)>>, <<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode(.3tls)>>, diff --git a/docs/man/nng_tls_config_ca_file.3tls.adoc b/docs/man/nng_tls_config_ca_file.3tls.adoc index 15e14eb7..04d76934 100644 --- a/docs/man/nng_tls_config_ca_file.3tls.adoc +++ b/docs/man/nng_tls_config_ca_file.3tls.adoc @@ -47,6 +47,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. `NNG_EINVAL`:: The contents of _path_ are invalid or do not contain a valid PEM certificate. @@ -55,6 +56,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode(3tls)>>, diff --git a/docs/man/nng_tls_config_cert_key_file.3tls.adoc b/docs/man/nng_tls_config_cert_key_file.3tls.adoc index 8375f807..47581e02 100644 --- a/docs/man/nng_tls_config_cert_key_file.3tls.adoc +++ b/docs/man/nng_tls_config_cert_key_file.3tls.adoc @@ -52,6 +52,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. `NNG_EINVAL`:: The contents of _path_ are invalid. @@ -60,6 +61,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_tls_config_own_cert.3tls#,nng_tls_config_own_cert(3tls)>>, diff --git a/docs/man/nng_tls_config_free.3tls.adoc b/docs/man/nng_tls_config_free.3tls.adoc index bac0ae55..b6733d4b 100644 --- a/docs/man/nng_tls_config_free.3tls.adoc +++ b/docs/man/nng_tls_config_free.3tls.adoc @@ -39,5 +39,6 @@ None. == SEE ALSO +[.text-left] <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_tls_config_own_cert.3tls.adoc b/docs/man/nng_tls_config_own_cert.3tls.adoc index 0d6418a7..00c84ca9 100644 --- a/docs/man/nng_tls_config_own_cert.3tls.adoc +++ b/docs/man/nng_tls_config_own_cert.3tls.adoc @@ -53,12 +53,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. `NNG_EINVAL`:: An invalid _cert_ or _key_ was supplied. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_tls_config_cert_key_file.3tls#,nng_tls_config_cert_key_file(3tls)>>, diff --git a/docs/man/nng_tls_config_server_name.3tls.adoc b/docs/man/nng_tls_config_server_name.3tls.adoc index c8f4b100..85fe51f6 100644 --- a/docs/man/nng_tls_config_server_name.3tls.adoc +++ b/docs/man/nng_tls_config_server_name.3tls.adoc @@ -41,11 +41,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode(3tls)>>, diff --git a/docs/man/nng_tls_register.3.adoc b/docs/man/nng_tls_register.3.adoc index a98a3211..a01388eb 100644 --- a/docs/man/nng_tls_register.3.adoc +++ b/docs/man/nng_tls_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_tls.7#,nng_tls(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_url_clone.3.adoc b/docs/man/nng_url_clone.3.adoc index b6553f6c..e201b7a9 100644 --- a/docs/man/nng_url_clone.3.adoc +++ b/docs/man/nng_url_clone.3.adoc @@ -34,10 +34,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to duplicate a message. == SEE ALSO +[.text-left] <<nng_url_free.3#,nng_url_free(3)>>, <<nng_url_parse.3#,nng_url_parse(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_url_free.3.adoc b/docs/man/nng_url_free.3.adoc index a210d016..3e49f5d6 100644 --- a/docs/man/nng_url_free.3.adoc +++ b/docs/man/nng_url_free.3.adoc @@ -37,6 +37,7 @@ None. == SEE ALSO +[.text-left] <<nng_url_clone.3#,nng_url_clone(3)>>, <<nng_url_parse.3#,nng_url_parse(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_url_parse.3.adoc b/docs/man/nng_url_parse.3.adoc index 699735dc..ec44ccf5 100644 --- a/docs/man/nng_url_parse.3.adoc +++ b/docs/man/nng_url_parse.3.adoc @@ -82,12 +82,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. `NNG_EINVAL`:: An invalid URL was supplied. == SEE ALSO +[.text-left] <<nng_url_clone.3#,nng_url_clone(3)>>, <<nng_url_free.3#,nng_url_free(3)>>, <<nng_strerror.3#,nng_strerror(3)>>, diff --git a/docs/man/nng_version.3.adoc b/docs/man/nng_version.3.adoc index 347f1458..1c52d5e8 100644 --- a/docs/man/nng_version.3.adoc +++ b/docs/man/nng_version.3.adoc @@ -53,5 +53,6 @@ None. == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc index bc0d9d51..bec579ac 100644 --- a/docs/man/nng_ws.7.adoc +++ b/docs/man/nng_ws.7.adoc @@ -27,7 +27,7 @@ int nng_wss_register(void); (((WebSocket)))(((transport, _ws_ and _wss_))) The ((_ws_ transport)) provides communication support between -_nng_ sockets across a TCP/IP network using +_nng_ sockets across a TCP/IP network using https://tools.ietf.org/html/rfc6455[WebSockets]. Both IPv4 and IPv6 are supported when the underlying platform also supports it. @@ -39,7 +39,7 @@ http://nanomsg.org/rfcs/sp-websocket-v1.html[WebSocket Mapping for Scalability P Depending upon how the library was built, it may be necessary to register the transport by calling `<<nng_ws_register.3#,nng_ws_register()>>`. -If ((TLS)) support is enabled in the library, secure WebSockets (over TLS v1.2) +If ((TLS)) support is enabled in the library, secure WebSockets (over TLS v1.2) can be used as well, but the secure transport may have to be registered using the `<<nng_wss_register.3#,nng_wss_register()>>` function. @@ -180,6 +180,7 @@ results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`. == SEE ALSO +[.text-left] <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_sockaddr.5#,nng_sockaddr(5)>>, <<nng_sockaddr_in.5#,nng_sockaddr_in(5)>>, diff --git a/docs/man/nng_ws_register.3.adoc b/docs/man/nng_ws_register.3.adoc index f6b0d068..414f6a8e 100644 --- a/docs/man/nng_ws_register.3.adoc +++ b/docs/man/nng_ws_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_ws.7#,nng_ws(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_wss_register.3.adoc b/docs/man/nng_wss_register.3.adoc index b1ee3689..946ffbf1 100644 --- a/docs/man/nng_wss_register.3.adoc +++ b/docs/man/nng_wss_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_ws.7#,nng_ws(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index 6325bbb3..9142139c 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -141,10 +141,10 @@ The following transport options are available: can store (and reuse) persistent state, such as key materials, node identity, and federation membership. This option must be set before the ZeroTier transport is first used. - If this value is empty, then an ephemeral ZeroTier node is created, + If this value is empty, then an ephemeral ZeroTier node is created, nd no persistent state is used. The default is to use an ephemeral node. -+ ++ NOTE: If this option is set to different values on different sockets, dialers, or listeners, then separate nodes will be created. It is perfectly valid for an application to have multiple node identities @@ -222,8 +222,9 @@ in this fashion. This write-only option takes a single `uint64_t` indicating the moon ID to "`deorbit`". If the node is not already orbiting the moon, then this has no effect. - + == SEE ALSO +[.text-left] <<nng_sockaddr_zt.5#,nng_sockaddr_zt(5)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc index 181429a6..4d7bb804 100644 --- a/docs/man/nng_zt_register.3.adoc +++ b/docs/man/nng_zt_register.3.adoc @@ -33,10 +33,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_ENOTSUP`:: The transport is not supported. == SEE ALSO +[.text-left] <<nng_zerotier.7#,nng_zerotier(7)>>, <<nng.7#,nng(7)>> diff --git a/docs/man/nngcat.1.adoc b/docs/man/nngcat.1.adoc index 1dc831cd..fec20c72 100644 --- a/docs/man/nngcat.1.adoc +++ b/docs/man/nngcat.1.adoc @@ -313,6 +313,7 @@ $ nngcat --sub --dial=${addr} --quoted & == SEE ALSO +[.text-left] <<libnng.3#,libnng(3)>>, <<nng.7#,nng(7)>>, <<nng_bus.7#,nng_bus(7)>>, |