diff --git a/docs/man/nn_allocmsg.3compat.adoc b/docs/man/nn_allocmsg.3compat.adoc index 9ceddb2a5..a53da55cf 100644 --- a/docs/man/nn_allocmsg.3compat.adoc +++ b/docs/man/nn_allocmsg.3compat.adoc @@ -33,16 +33,16 @@ The value of _size_ must be positive, and small enough to hold reasonable message data plus book-keeping information. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. The value of _type_ *must* be zero. (This argument was reserved to support different kinds of memory spaces for RDMA devices, but this was never developed in the legacy API.) The returned message must be disposed of by either -`<>` or -`<>` when the caller is finished with it. +xref:nn_freemsg.3compat.adoc[`nn_freemsg()`] or +xref:nn_send.3compat.adoc[`nn_send()`] when the caller is finished with it. == RETURN VALUES @@ -59,9 +59,9 @@ on failure. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)], +xref:nn_reallocmsg.3compat.adoc[nn_reallocmsg(3compat)], +xref:nn_send.3compat.adoc[nn_send(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_bind.3compat.adoc b/docs/man/nn_bind.3compat.adoc index 3095e4ca4..7a9685bba 100644 --- a/docs/man/nn_bind.3compat.adoc +++ b/docs/man/nn_bind.3compat.adoc @@ -28,12 +28,12 @@ The `nn_bind()` function arranges for the socket _sock_ to accept connections at the address specified by _url_. An "`endpoint identifier`" for this socket's association with the _url_ is returned to the caller on success. -This ID can be used with `<>` to +This ID can be used with xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to "`unbind`" the socket from the address at _url_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. NOTE: The bind operation is performed asynchronously, and may not have completed before this function returns control to the caller. @@ -42,7 +42,7 @@ IMPORTANT: Only transports supported by legacy _libnanomsg_ may be used with this function. In particular, only the schemes `tcp://`, `ipc://`, `inproc://`, and `ws://` are supported with this function. -(Use the <> to use other schemes.) +(Use the xref:libnng.3.adoc[modern API] to use other schemes.) == RETURN VALUES @@ -59,9 +59,9 @@ This function returns a positive identifier on success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_connect.3compat.adoc[nn_connect(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_close.3compat.adoc b/docs/man/nn_close.3compat.adoc index 5ec13b907..1970b57d7 100644 --- a/docs/man/nn_close.3compat.adoc +++ b/docs/man/nn_close.3compat.adoc @@ -29,8 +29,8 @@ Any operations that are currently in progress will be terminated, and will fail with error `EBADF`. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. == RETURN VALUES @@ -45,7 +45,7 @@ This function returns zero on success, and -1 on failure. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_cmsg.3compat.adoc b/docs/man/nn_cmsg.3compat.adoc index 1b562c4f2..32d318106 100644 --- a/docs/man/nn_cmsg.3compat.adoc +++ b/docs/man/nn_cmsg.3compat.adoc @@ -29,12 +29,12 @@ struct nn_cmsghdr { == DESCRIPTION The `nn_cmsghdr` structure describes a block of control data that is -associated with a message either sent by `<>` -or received by `<>`. +associated with a message either sent by xref:nn_sendmsg.3compat.adoc[`nn_sendmsg()`] +or received by xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`]. NOTE: This structure and supporting macros are provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. Each header is followed by `cmsg_len` bytes of data, plus any padding required to align the structure. @@ -72,7 +72,7 @@ to align for another header. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nn_recvmsg.3compat.adoc[nn_recvmsg(3compat)], +xref:nn_sendmsg.3compat.adoc[nn_sendmsg(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_connect.3compat.adoc b/docs/man/nn_connect.3compat.adoc index 01f8195a7..2e669398c 100644 --- a/docs/man/nn_connect.3compat.adoc +++ b/docs/man/nn_connect.3compat.adoc @@ -28,12 +28,12 @@ The `nn_connect()` function arranges for the socket _sock_ to initiate connection to a peer at the address specified by _url_. An "`endpoint identifier`" for this socket's association with the _url_ is returned to the caller on success. -This ID can be used with `<>` to +This ID can be used with xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to "`unbind`" the socket from the address at _url_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. NOTE: The connect operation is performed asynchronously, and may not have completed before this function returns control to the caller. @@ -42,7 +42,7 @@ IMPORTANT: Only transports supported by legacy _libnanomsg_ may be used with this function. In particular, only the schemes `tcp://`, `ipc://`, `inproc://`, and `ws://` are supported with this function. -(Use the <> to use other schemes.) +(Use the xref:libnng.3.adoc[modern API] to use other schemes.) == RETURN VALUES @@ -58,9 +58,9 @@ This function returns a positive identifier success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_bind.3compat.adoc[nn_bind(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_device.3compat.adoc b/docs/man/nn_device.3compat.adoc index 4ca08819f..c69e1e046 100644 --- a/docs/man/nn_device.3compat.adoc +++ b/docs/man/nn_device.3compat.adoc @@ -29,13 +29,14 @@ received on one of the two sockets _sock1_ and _sock2_ are forwarded to the other. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. -The two sockets must be compatible, and must be <> +The two sockets must be compatible, and must be +xref:nng.7.adoc#raw_mode[raw mode] sockets. More detail about devices and how they can be used is available in the -new style <> documentation. +new style xref:nng_device.3.adoc[nng_device()] documentation. == RETURN VALUES @@ -52,7 +53,7 @@ one of the sockets is closed or an error occurs. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_errno.3compat.adoc b/docs/man/nn_errno.3compat.adoc index 655906e92..a048543df 100644 --- a/docs/man/nn_errno.3compat.adoc +++ b/docs/man/nn_errno.3compat.adoc @@ -28,8 +28,8 @@ The `nn_errno()` function returns the error number corresponding to the most recent failed operation by the calling thread. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. IMPORTANT: The error numbers returned from this function may include errors caused by system functions, which overlap the usual `errno` variable, @@ -74,6 +74,6 @@ If no operation has failed, then this will be zero. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nn_strerror.3compat.adoc[nn_strerror(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_freemsg.3compat.adoc b/docs/man/nn_freemsg.3compat.adoc index 48e2ad1cd..61127c3d4 100644 --- a/docs/man/nn_freemsg.3compat.adoc +++ b/docs/man/nn_freemsg.3compat.adoc @@ -25,11 +25,11 @@ int nn_freemsg(void *msg); == DESCRIPTION The `nn_freemsg()` deallocates a message previously allocated with -`<>` or similar functions. +xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`] or similar functions. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. == RETURN VALUES @@ -42,8 +42,8 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)], +xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_get_statistic.3compat.adoc b/docs/man/nn_get_statistic.3compat.adoc index c8e297e5f..89b11de2b 100644 --- a/docs/man/nn_get_statistic.3compat.adoc +++ b/docs/man/nn_get_statistic.3compat.adoc @@ -28,8 +28,8 @@ The `nn_get_statistic()` function exists only as a stub, and always returns zero. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. == RETURN VALUES @@ -42,5 +42,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_getsockopt.3compat.adoc b/docs/man/nn_getsockopt.3compat.adoc index 7701013a3..07da0a3c2 100644 --- a/docs/man/nn_getsockopt.3compat.adoc +++ b/docs/man/nn_getsockopt.3compat.adoc @@ -28,8 +28,8 @@ The `nn_getsockopt()` function gets a socket option on socket _sock_. The option retrieved is determined by the _level_ and _option_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. The value pointed to by _szp_ must be initialized to the size of the buffer pointed to by _val_. @@ -131,7 +131,7 @@ their different application-specific purposes. `NN_MAXTTL`:: Maximum "`hops`" through proxies and devices a message may go through. This value, if positive, provides some protection against forwarding loops in -<> chains. +xref:nng_device.3.adoc[device] chains. NOTE: Not all protocols offer this protection, so care should still be used in configuring device forwarding. @@ -220,9 +220,9 @@ This function returns zero on success, and -1 on failure. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nn_close.3compat.adoc[nn_close(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_getsockopt.3compat.adoc[nn_getsockopt(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_poll.3compat.adoc b/docs/man/nn_poll.3compat.adoc index 27c9cbcb7..c115fe49f 100644 --- a/docs/man/nn_poll.3compat.adoc +++ b/docs/man/nn_poll.3compat.adoc @@ -36,8 +36,8 @@ int nn_poll(struct nn_pollfd *pfds, int npfd, int timeout); The `nn_poll()` function polls a group of sockets for readiness to send or receive. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. The array of _nfds_ sockets to poll for are passed into _pfds_. Each member of this array is initialized with the `fd` field set to @@ -67,10 +67,10 @@ If the _timeout_ is -1, then the function waits forever, or until one of the requested events occurs. IMPORTANT: This function is only suitable for use with sockets obtained with the -`<>` function, and is not compatible +xref:nn_socket.3compat.adoc[`nn_socket()`] function, and is not compatible with file descriptors obtained via any other means. This includes file descriptors obtained using the `NN_SNDFD` or `NN_RCVFD` -options with `<>` +options with xref:nn_getsockopt.3compat.adoc[`nn_getsockopt()`] NOTE: This function is significantly less efficient than other polling or asynchronous I/O mechanisms, and is provided for API compatibility only. @@ -94,9 +94,9 @@ This function returns the number of sockets with events on success, or -1 on err == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_recv.3compat.adoc[nn_recv(3compat)], +xref:nn_send.3compat.adoc[nn_send(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_reallocmsg.3compat.adoc b/docs/man/nn_reallocmsg.3compat.adoc index 57d7121fa..d48b5d403 100644 --- a/docs/man/nn_reallocmsg.3compat.adoc +++ b/docs/man/nn_reallocmsg.3compat.adoc @@ -27,8 +27,8 @@ void *nn_reallocmsg(void *old, size_t size); The `nn_reallocmsg()` reallocates the message _old_, making it of size _size_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. On success, the contents of _old_ are copied into the new message (truncating if appropriate), then _old_ is deallocated, and a pointer @@ -52,8 +52,8 @@ on failure. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)], +xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_recv.3compat.adoc b/docs/man/nn_recv.3compat.adoc index 1b77f28fe..9e44d840b 100644 --- a/docs/man/nn_recv.3compat.adoc +++ b/docs/man/nn_recv.3compat.adoc @@ -30,22 +30,22 @@ at the location specified by _data_, unless _size_ is the special value `NN_MSG`, indicating a zero-copy operation. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. If _size_ has the special value `NN_MSG`, then a zero-copy operation is performed. In this case, instead of copying the message data into the address specified by _data_, a new message large enough to hold the message data will be allocated (as if by the -function `<>`), and the message +function xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]), and the message payload will be stored accordingly. In this case, the value stored at _data_ will not be message data, but a pointer to the message itself. In this case, on success, the caller shall take responsibility for the final disposition of the message (such as by sending it to -another peer using `<>`) or -`<>`. +another peer using xref:nn_send.3compat.adoc[`nn_send()`]) or +xref:nn_freemsg.3compat.adoc[`nn_freemsg()`]. The _flags_ field may contain the special flag `NN_DONTWAIT`. In this case, if the no message is available for immediate receipt, @@ -67,9 +67,9 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_recvmsg.3compat.adoc[nn_recvmsg(3compat)], +xref:nn_send.3compat.adoc[nn_send(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_recvmsg.3compat.adoc b/docs/man/nn_recvmsg.3compat.adoc index ae70585d7..e0fcc758a 100644 --- a/docs/man/nn_recvmsg.3compat.adoc +++ b/docs/man/nn_recvmsg.3compat.adoc @@ -28,8 +28,8 @@ The `nn_recvmsg()` function receives a message into the header described by _hdr_ using the socket _sock_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. The _flags_ field may contain the special flag `NN_DONTWAIT`. In this case, if no message is ready for receiving on _sock_, @@ -62,16 +62,16 @@ The last member of this array may have the `iov_len` field set to `NN_MSG`, in which case the function shall allocate a message buffer, and store the pointer to it at the address indicated by `iov_base`. This can help save an extra copy operation. -The buffer should be deallocated by `<>` +The buffer should be deallocated by xref:nn_freemsg.3compat.adoc[`nn_freemsg()`] or similar when it is no longer needed. The values of `msg_control` and `msg_controllen` describe a buffer of ancillary data associated with the message. This is currently only useful to obtain the message headers -used with <> sockets. +used with xref:nng.7.adoc#raw_mode[raw mode] sockets. In all other circumstances these fields should be zero. Details about this structure are covered in -`<>`. +xref:nn_cmsg.3compat.adoc[`nn_cmsg(3compat)`]. == RETURN VALUES @@ -90,10 +90,10 @@ This function returns the number of bytes received on success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_cmsg.3compat.adoc[nn_cmsg(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_recv.3compat.adoc[nn_recv(3compat)], +xref:nn_send.3compat.adoc[nn_send(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_send.3compat.adoc b/docs/man/nn_send.3compat.adoc index cb1146a56..1a3efb0ce 100644 --- a/docs/man/nn_send.3compat.adoc +++ b/docs/man/nn_send.3compat.adoc @@ -28,16 +28,16 @@ The `nn_send()` function creates a message containing _data_ (of size _size_), and sends using the socket _sock_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. If _size_ has the special value `NN_MSG`, then a zero-copy operation is performed. In this case, _data_ points not to the message content itself, but instead is a pointer to the pointer, an extra level of pointer indirection. The message must have been previously allocated by -`<>` or -`<>`, using the same `NN_MSG` size. +xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`] or +xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`]`, using the same `NN_MSG` size. In this case, the "`ownership`" of the message shall remain with the caller, unless the function returns 0, indicating that the function has taken responsibility for delivering or disposing of the @@ -66,9 +66,9 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_recv.3compat.adoc[nn_recv(3compat)], +xref:nn_sendmsg.3compat.adoc[nn_sendmsg(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_sendmsg.3compat.adoc b/docs/man/nn_sendmsg.3compat.adoc index 67b3ddc8b..b339bfe66 100644 --- a/docs/man/nn_sendmsg.3compat.adoc +++ b/docs/man/nn_sendmsg.3compat.adoc @@ -28,8 +28,8 @@ The `nn_sendmsg()` function sends the message described by _hdr_ using the socket _sock_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. The _flags_ field may contain the special flag `NN_DONTWAIT`. In this case, if the socket is unable to accept more data for sending, @@ -59,7 +59,7 @@ There are `msg_iovlen` elements in this array, each of which has the base address (`iov_base`) and length (`iov_len`) indicated. For buffers allocated for zero copy -(such as by `<>`), the value +(such as by xref:nn_allocmsg.3compat.adoc[`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. In this case, the value of `iov_len` should be `NN_MSG`, @@ -73,10 +73,10 @@ at its choice.) The values of `msg_control` and `msg_controllen` describe a buffer of ancillary data to send the message. This is currently only useful to provide the message headers -used with <> sockets. +used with xref:nng.7.adoc#raw_mode[raw mode] sockets. In all other circumstances these fields should be zero. Details about this structure are covered in -`<>`. +xref:nn_cmsg.3compat.adoc[`nn_cmsg(3compat)`]. NOTE: The send operation is performed asynchronously, and may not have completed before this function returns control to the caller. @@ -98,10 +98,10 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_cmsg.3compat.adoc[nn_cmsg(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_recv.3compat.adoc[nn_recv(3compat)], +xref:nn_send.3compat.adoc[nn_send(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_setsockopt.3compat.adoc b/docs/man/nn_setsockopt.3compat.adoc index cfee6d085..eadf6574d 100644 --- a/docs/man/nn_setsockopt.3compat.adoc +++ b/docs/man/nn_setsockopt.3compat.adoc @@ -31,8 +31,8 @@ The value of the option is set by _val_, and _sz_, which are pointers to the actual value and the size of the value, respectively. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. The _level_ determines whether the option is a generic socket option, or is transport-specific. @@ -125,7 +125,7 @@ their different application-specific purposes. `NN_MAXTTL`:: Maximum "`hops`" through proxies and devices a message may go through. This value, if positive, provides some protection against forwarding loops in -<> chains. +xref:nng_device.3.adoc[device] chains. NOTE: Not all protocols offer this protection, so care should still be used in configuring device forwarding. @@ -198,9 +198,9 @@ This function returns zero on success, and -1 on failure. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nn_close.3compat.adoc[nn_close(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_getsockopt.3compat.adoc[nn_getsockopt(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_shutdown.3compat.adoc b/docs/man/nn_shutdown.3compat.adoc index 7602ff44a..eb9efd246 100644 --- a/docs/man/nn_shutdown.3compat.adoc +++ b/docs/man/nn_shutdown.3compat.adoc @@ -31,8 +31,8 @@ Additionally, any established connections associated with _ep_ will be closed. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. == RETURN VALUES @@ -47,9 +47,9 @@ This function returns zero on success, and -1 on error. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nn_bind.3compat.adoc[nn_bind(3compat)], +xref:nn_connect.3compat.adoc[nn_connect(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nn_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_socket.3compat.adoc b/docs/man/nn_socket.3compat.adoc index 1cc039149..bee2ffc0b 100644 --- a/docs/man/nn_socket.3compat.adoc +++ b/docs/man/nn_socket.3compat.adoc @@ -28,8 +28,8 @@ The `nn_socket()` function creates socket using the address family _af_ and protocol _proto_ and returns it. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. IMPORTANT: Mixing the compatibility API and the modern API is not supported on a given socket. @@ -40,22 +40,22 @@ The address family _af_ can be one of two values: [horizontal] `AF_SP`:: Normal socket. -`AF_SP_RAW`:: <> socket. +`AF_SP_RAW`:: xref:nng.7.adoc#raw_mode["`Raw mode`"] socket. The protocol indicates the protocol to be used when creating the socket. The following protocols are defined: [horizontal] -`NN_PAIR`:: <> protocol. -`NN_PUB`:: <> protocol. -`NN_SUB`:: <> protocol. -`NN_REQ`:: <> protocol. -`NN_REP`:: <> protocol. -`NN_PUSH`:: <> protocol. -`NN_PULL`:: <> protocol. -`NN_SURVEYOR`:: <> protocol. -`NN_RESPONDENT`:: <> protocol. -`NN_BUS`:: <> protocol. +`NN_PAIR`:: xref:nng_pair.7.adoc[Pair] protocol. +`NN_PUB`:: xref:nng_pub.7.adoc[Publisher] protocol. +`NN_SUB`:: xref:nng_sub.7.adoc[Subscriber] protocol. +`NN_REQ`:: xref:nng_req.7.adoc[Requestor] protocol. +`NN_REP`:: xref:nng_rep.7.adoc[Replier] protocol. +`NN_PUSH`:: xref:nng_push.7.adoc[Push] protocol. +`NN_PULL`:: xref:nng_pull.7.adoc[Pull] protocol. +`NN_SURVEYOR`:: xref:nng_surveyor.7.adoc[Surveyor] protocol. +`NN_RESPONDENT`:: xref:nng_respondent.7.adoc[Respondent] protocol. +`NN_BUS`:: xref:nng_bus.7.adoc[Bus] protocol. == RETURN VALUES @@ -71,8 +71,8 @@ This function returns a valid socket number on success, and -1 on failure. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nn_close.3compat.adoc[nn_close(3compat)], +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_strerror.3compat.adoc b/docs/man/nn_strerror.3compat.adoc index e3fd6470e..e7959084b 100644 --- a/docs/man/nn_strerror.3compat.adoc +++ b/docs/man/nn_strerror.3compat.adoc @@ -28,8 +28,8 @@ The `nn_strerror()` function returns a human readable message corresponding to the given error number _err_. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. == RETURN VALUES @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nn_term.3compat.adoc b/docs/man/nn_term.3compat.adoc index 36cb74827..79b6a1e37 100644 --- a/docs/man/nn_term.3compat.adoc +++ b/docs/man/nn_term.3compat.adoc @@ -30,8 +30,8 @@ Any operations that are currently in progress will be terminated, and will fail with error `EBADF` or `ETERM`. NOTE: This function is provided for API -<> with legacy _libnanomsg_. -Consider using the relevant <> instead. +xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. +Consider using the relevant xref:libnng.3.adoc[modern API] instead. IMPORTANT: This function is not thread-safe, and is not suitable for use in library calls. @@ -53,7 +53,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nn_errno.3compat.adoc[nn_errno(3compat)], +xref:nn_socket.3compat.adoc[nn_socket(3compat)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng.7.adoc b/docs/man/nng.7.adoc index 082b74fd2..61981c030 100644 --- a/docs/man/nng.7.adoc +++ b/docs/man/nng.7.adoc @@ -52,37 +52,37 @@ other languages please check the http://nanomsg.org/[website]. == Protocols [horizontal] -<>:: Bus protocol -<>:: Pair protocol -<>:: Publisher side of publish/subscribe protocol -<>:: Pull side of pipeline protocol -<>:: Push side of pipeline protocol -<>:: Subscriber side of publish/subscribe protocol -<>:: Reply side of request/reply protocol -<>:: Request side of request/reply protocol -<>:: Respondent side of survey protocol -<>:: Surveyor side of survey protocol - -//* <> - Bus protocol -//* <> - Pair protocol -//* <> - Publisher side of publish/subscribe protocol -//* <> - Pull side of pipeline protocol -//* <> - Push side of pipeline protocol -//* <> - Subscriber side of publish/subscribe protocol -//* <> - Reply side of request/reply protocol -//* <> - Request side of request/reply protocol -//* <> - Respondent side of survey protocol -//* <> - Surveyor side of survey protocol +xref:nng_bus.7.adoc[nng_bus(7)]:: Bus protocol +xref:nng_pair.7.adoc[nng_pair(7)]:: Pair protocol +xref:nng_pub.7.adoc[nng_pub(7)]:: Publisher side of publish/subscribe protocol +xref:nng_pull.7.adoc[nng_pull(7)]:: Pull side of pipeline protocol +xref:nng_push.7.adoc[nng_push(7)]:: Push side of pipeline protocol +xref:nng_sub.7.adoc[nng_sub(7)]:: Subscriber side of publish/subscribe protocol +xref:nng_rep.7.adoc[nng_rep(7)]:: Reply side of request/reply protocol +xref:nng_req.7.adoc[nng_req(7)]:: Request side of request/reply protocol +xref:nng_respondent.7.adoc[nng_respondent(7)]:: Respondent side of survey protocol +xref:nng_surveyor.7.adoc[nng_surveyor(7)]:: Surveyor side of survey protocol + +//* xref:nng_bus.7.adoc[nng_bus(7)] - Bus protocol +//* xref:nng_pair.7.adoc[nng_pair(7)] - Pair protocol +//* xref:nng_pub.7.adoc[nng_pub(7)] - Publisher side of publish/subscribe protocol +//* xref:nng_pull.7.adoc[nng_pull(7)] - Pull side of pipeline protocol +//* xref:nng_push.7.adoc[nng_push(7)] - Push side of pipeline protocol +//* xref:nng_sub.7.adoc[nng_sub(7)] - Subscriber side of publish/subscribe protocol +//* xref:nng_rep.7.adoc[nng_rep(7)] - Reply side of request/reply protocol +//* xref:nng_req.7.adoc[nng_req(7)] - Request side of request/reply protocol +//* xref:nng_respondent.7.adoc[nng_respondent(7)] - Respondent side of survey protocol +//* xref:nng_surveyor.7.adoc[nng_surveyor(7)] - Surveyor side of survey protocol == Transports [horizontal] -<>:: Intra-process transport -<>:: Inter-process transport -<>:: TLSv1.2 over TCP transport -<>:: TCP (and TCPv6) transport -<>:: WebSocket transport -<>:: ZeroTier transport +xref:nng_inproc.7.adoc[nng_inproc(7)]:: Intra-process transport +xref:nng_ipc.7.adoc[nng_ipc(7)]:: Inter-process transport +xref:nng_tls.7.adoc[nng_tls(7)]:: TLSv1.2 over TCP transport +xref:nng_tcp.7.adoc[nng_tcp(7)]:: TCP (and TCPv6) transport +xref:nng_ws.7.adoc[nng_ws(7)]:: WebSocket transport +xref:nng_zerotier.7.adoc[nng_zerotier(7)]:: ZeroTier transport == Conceptual Overview @@ -92,14 +92,14 @@ socket implements precisely one _nng_ protocol. Each socket can be used to send and receive messages (if the protocol) supports it, and implements the appropriate protocol semantics. -For example, <> sockets automatically filter incoming +For example, xref:nng_sub.7.adoc[_sub_] sockets automatically filter incoming messages to discard those for topics that have not been subscribed. _nng_ sockets are message oriented, so that messages are either delivered wholly, or not at all. Partial delivery is not possible. Furthermore, _nng_ does not provide any other delivery or ordering guarantees; messages may be dropped or reordered -(Some protocols, such as <> may offer stronger +(Some protocols, such as xref:nng_req.7.adoc[_req_] may offer stronger guarantees by performing their own retry and validation schemes.) Each socket can have zero, one, or many "endpoints", which are either @@ -133,23 +133,23 @@ other than in a few specific circumstances. (((cooked mode)))(((raw mode))) Most applications will use _nng_ sockets in "`cooked`" mode. This mode provides the full semantics of the protocol. -For example, <> sockets will automatically +For example, xref:nng_req.7.adoc[_req_] sockets will automatically match a reply to a request, and resend requests periodically if no reply was received. -There are situations, such as with <>, +There are situations, such as with xref:nng_device.3.adoc[proxies], where it is desirable to bypass these semantics and simply pass messages to and from the socket with no extra semantic handling. This is possible using "`raw`" mode sockets. Raw mode sockets are generally constructed with a different function, -such as <>. +such as xref:nng_req_open.3.adoc[`nng_req0_open_raw()`]. Using these sockets, the application can simply send and receive messages, and is responsible for supplying any additional socket semantics. Typically this means that the application will need to inspect message headers on incoming messages, and supply them on outgoing messages. -TIP: The <> function only works with raw mode +TIP: The xref:nng_device.3.adoc[`nng_device()`] function only works with raw mode sockets, but as it only forwards the messages, no additional application processing is needed. @@ -195,10 +195,10 @@ confusion when they are parsed on different systems. == API -The library API is documented at <>. +The library API is documented at xref:libnng.3.adoc[libnng(3)]. == SEE ALSO [.text-left] -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_compat.3compat.adoc[nng_compat(3compat)] diff --git a/docs/man/nng_bus.7.adoc b/docs/man/nng_bus.7.adoc index c79e2d9df..45c69f02d 100644 --- a/docs/man/nng_bus.7.adoc +++ b/docs/man/nng_bus.7.adoc @@ -69,7 +69,7 @@ contain the incoming xref:nng_pipe.5.adoc[pipe] ID as the sole element in the he If a message containing such a header is sent using a raw _bus_ socket, then, the message will be delivered to all connected pipes _except_ the one identified in the header. -This behavior is intended for use with xref:nng_device.3#device,device] +This behavior is intended for use with xref:nng_device.3.adoc[device] configurations consisting of just a single socket. Such configurations are useful in the creation of rebroadcasters, and this capability prevents a message from being routed back to its source. diff --git a/docs/man/nng_ctx.5.adoc b/docs/man/nng_ctx.5.adoc index f8a444c68..b1285c2c2 100644 --- a/docs/man/nng_ctx.5.adoc +++ b/docs/man/nng_ctx.5.adoc @@ -59,7 +59,7 @@ global behavior. (((concurrent)))(((raw mode))) Historically, applications wanting to use a stateful protocol concurrently -would have to resort to xref:nng.7#raw_mode[raw mode] sockets, which bypasses +would have to resort to xref:nng.7.adoc#raw_mode[raw mode] sockets, which bypasses much of the various protocol handling, leaving it to up to the application to do so. Contexts make it possible to still benefit from advanced protocol handling, diff --git a/docs/man/nng_http_conn_close.3http.adoc b/docs/man/nng_http_conn_close.3http.adoc index 18cca6747..95c266e29 100644 --- a/docs/man/nng_http_conn_close.3http.adoc +++ b/docs/man/nng_http_conn_close.3http.adoc @@ -41,7 +41,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_read.3http.adoc b/docs/man/nng_http_conn_read.3http.adoc index 671af4aa6..dfb6e08ca 100644 --- a/docs/man/nng_http_conn_read.3http.adoc +++ b/docs/man/nng_http_conn_read.3http.adoc @@ -29,20 +29,20 @@ The `nng_http_conn_read()` function starts an asynchronous read from the HTTP connection _conn_, into the scatter/gather vector located in the asynchronous I/O structure _aio_. -NOTE: The `<>` function must have been +NOTE: The xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function must have been called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be obtained via -`<>`. +xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been read, or an error has occurred. Therefore, the number of bytes read may be less than requested. The actual number of bytes read can be determined with -`<>`. +xref:nng_aio_count.3.adoc[`nng_aio_count()`]. TIP: This function is intended to facilitate uses cases that involve changing the protocol from HTTP, such as WebSocket. @@ -66,12 +66,12 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_read_all.3http.adoc b/docs/man/nng_http_conn_read_all.3http.adoc index 078170fef..21b892f05 100644 --- a/docs/man/nng_http_conn_read_all.3http.adoc +++ b/docs/man/nng_http_conn_read_all.3http.adoc @@ -29,12 +29,12 @@ The `nng_http_conn_read_all()` function starts an asynchronous read from the HTTP connection _conn_, into the scatter/gather vector located in the asynchronous I/O structure _aio_. -NOTE: The `<>` function must have been +NOTE: The xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function must have been called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result -may be obtained via `<>`. +may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. The I/O operation completes only when the entire amount of data @@ -44,7 +44,7 @@ completes successfully, then the entire requested data has been read. It is still possible for a partial read to complete in the event of an error. The actual number of bytes read can be determined with -`<>`. +xref:nng_aio_count.3.adoc[`nng_aio_count()`]. TIP: The main purpose for this function is to facilitate reading HTTP body content, after first determining the length of the body content @@ -68,11 +68,11 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3)], +xref:nng_http_conn_read.3http.adoc[nng_http_conn_read(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_read_req.3http.adoc b/docs/man/nng_http_conn_read_req.3http.adoc index f4131f193..01d790cce 100644 --- a/docs/man/nng_http_conn_read_req.3http.adoc +++ b/docs/man/nng_http_conn_read_req.3http.adoc @@ -33,12 +33,12 @@ of the related headers. NOTE: Any HTTP entity/body data associated with the request is *not* read automatically. The caller should use -`<>` +xref:nng_http_conn_read_all.3http.adoc[`nng_http_conn_read_all()`] to read the entity data, based on the details of the request itself. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result -may be obtained via `<>`. +may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. == RETURN VALUES @@ -58,9 +58,9 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_read_res.3http.adoc b/docs/man/nng_http_conn_read_res.3http.adoc index 96e64ed6f..ff5cd7a33 100644 --- a/docs/man/nng_http_conn_read_res.3http.adoc +++ b/docs/man/nng_http_conn_read_res.3http.adoc @@ -33,18 +33,18 @@ of the related headers. NOTE: Any HTTP entity/body data associated with the response is *not* read automatically. The caller should use -`<>` to read the entity +xref:nng_http_conn_read_all.3http.adoc[`nng_http_conn_read_all`] to read the entity data, based on the details of the response itself. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result may be -obtained via `<>`. +obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. NOTE: Consider using the -`<>` or -`<>` functions, +xref:nng_http_client_transact.3http.adoc[`nng_http_client_transact()`] or +xref:nng_http_conn_transact.3http.adoc[`nng_http_conn_transact()`] functions, which provide a simpler interface for performing a complete HTTP client transaction. @@ -65,11 +65,11 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_transact.3http.adoc[nng_http_client_transact(3http)], +xref:nng_http_conn_transact.3http.adoc[nng_http_conn_transact(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_transact.3http.adoc b/docs/man/nng_http_conn_transact.3http.adoc index a38592b66..7239f6287 100644 --- a/docs/man/nng_http_conn_transact.3http.adoc +++ b/docs/man/nng_http_conn_transact.3http.adoc @@ -32,18 +32,18 @@ HTTP exchange over the connection _conn_, sending the request _req_ _res_. The entire response is read, including any associated body, which can subsequently be obtained using -`<>`. +xref:nng_http_res_get_data.3http.adoc[`nng_http_res_get_data()`]. This function is intended to make creation of client applications easier, by performing multiple asynchronous operations required to complete an entire HTTP transaction. If an error occurs, the caller should close _conn_ with -`<>`, as it may not +xref:nng_http_conn_close.3http.adoc[`nng_http_conn_close()`], as it may not necessarily be usable with other transactions. A similar function, -`<>`, +xref:nng_http_client_transact.3http.adoc[`nng_http_client_transact()`], exists. That function behaves similarily, but creates a connection on demand for the transaction, and disposes of it when finished. @@ -60,7 +60,7 @@ request interleaving. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result -may be obtained via `<>`. +may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. == RETURN VALUES @@ -81,13 +81,13 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_transact.3http.adoc[nng_http_client_transact(3http)], +xref:nng_http_conn_read_res.3http.adoc[nng_http_conn_read_res(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng_http_conn_write_req.3http.adoc[nng_http_conn_write_req(3http)], +xref:nng_http_res_get_data.3http.adoc[nng_http_res_get_data(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_write.3http.adoc b/docs/man/nng_http_conn_write.3http.adoc index 5d297e80b..d2e1ac314 100644 --- a/docs/man/nng_http_conn_write.3http.adoc +++ b/docs/man/nng_http_conn_write.3http.adoc @@ -29,19 +29,19 @@ The `nng_http_conn_write()` function starts an asynchronous write to the HTTP connection _conn_ from the scatter/gather vector located in the asynchronous I/O structure _aio_. -NOTE: The `<>` function must have been +NOTE: The xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function must have been called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final -result may be obtained via `<>`. +result may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been written, or an error has occurred. Therefore, the number of bytes written may be less than requested. The actual number of bytes written can be determined with -`<>`. +xref:nng_aio_count.3.adoc[`nng_aio_count()`]. TIP: This function is intended to facilitate uses cases that involve changing the protocol from HTTP, such as WebSocket. @@ -65,12 +65,12 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_conn_write_all.3http.adoc[nng_http_conn_write_all(3http)], +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_write_all.3http.adoc b/docs/man/nng_http_conn_write_all.3http.adoc index ea982e54c..329a83029 100644 --- a/docs/man/nng_http_conn_write_all.3http.adoc +++ b/docs/man/nng_http_conn_write_all.3http.adoc @@ -29,12 +29,12 @@ The `nng_http_conn_write_all()` function starts an asynchronous write to the HTTP connection _conn_, into the scatter/gather vector located in the asynchronous I/O structure _aio_. -NOTE: The `<>` function must have been +NOTE: The xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function must have been called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the -final result may be obtained via `<>`. +final result may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. The I/O operation completes only when the entire amount of data @@ -44,23 +44,23 @@ been written. It is still possible for a partial write to complete in the event of an error. The actual number of bytes written can be determined with -`<>`. +xref:nng_aio_count.3.adoc[`nng_aio_count()`]. TIP: The main purpose for this function is to facilitate writing HTTP body content. TIP: Usually an HTTP request or response will have been written immediately -prior to this with `<>` or -`<>`. +prior to this with xref:nng_http_conn_write_req.3http.adoc[`http_conn_write_req()`] or +xref:nng_http_conn_write_res.3http.adoc[`http_conn_write_res()`]. In that case the request or response should have also contained an `Content-Length` header, and possibly a `Content-Type` header. TIP: An easier solution to sending HTTP content data, is to include the content with the request or reply using a function like -`<>`. +xref:nng_http_req_copy_data.3http.adoc[`nng_http_req_copy_data()`]. In that case, the body data will be written automatically by the -`<>` or -`<>` function. +xref:nng_http_conn_write_req.3http.adoc[`http_conn_write_req()`] or +xref:nng_http_conn_write_req.3http.adoc[`http_conn_write_res()`] function. == RETURN VALUES @@ -80,17 +80,17 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_conn_write.3http.adoc[nng_http_conn_write(3http)], +xref:nng_http_conn_write_req.3http.adoc[http_conn_write_req(3http)], +xref:nng_http_conn_write_res.3http.adoc[http_conn_write_res(3http)], +xref:nng_http_req_copy_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng_http_req_set_data.3http.adoc[nng_http_req_set_data(3http)], +xref:nng_http_res_copy_data.3http.adoc[nng_http_res_copy_data(3http)], +xref:nng_http_res_set_data.3http.adoc[nng_http_res_set_data(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_write_req.3http.adoc b/docs/man/nng_http_conn_write_req.3http.adoc index 338ab26d9..faed76040 100644 --- a/docs/man/nng_http_conn_write_req.3http.adoc +++ b/docs/man/nng_http_conn_write_req.3http.adoc @@ -31,17 +31,17 @@ the HTTP request _req_ to the connection _conn_. The entire request is sent, including headers, and if present, the request body data. (The request body can be set with -`<>` or -`<>`.) +xref:nng_http_req_set_data.3http.adoc[`nng_http_req_set_data()`] or +xref:nng_http_req_copy_data.3http.adoc[`nng_http_req_copy_data()`].) This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result -may be obtained via `<>`. +may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. NOTE: Consider using the -`<>` or -`<>` functions, +xref:nng_http_client_transact.3http.adoc[`nng_http_client_transact()`] or +xref:nng_http_conn_transact.3http.adoc[`nng_http_conn_transact()`] functions, which provide a simpler interface for performing a complete HTTP client transaction. @@ -62,11 +62,11 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_transact.3http.adoc[nng_http_client_transact(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng_http_conn_transact.3http.adoc[nng_http_conn_transact(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_conn_write_res.3http.adoc b/docs/man/nng_http_conn_write_res.3http.adoc index 62d7a3d12..6c9987852 100644 --- a/docs/man/nng_http_conn_write_res.3http.adoc +++ b/docs/man/nng_http_conn_write_res.3http.adoc @@ -31,12 +31,12 @@ the HTTP response _res_ to the connection _conn_. The entire response is sent, including headers, and if present, the response body data. (The response body can be set with -`<>` or -`<>`.) +xref:nng_http_res_set_data.3http.adoc[`nng_http_res_set_data()`] or +xref:nng_http_res_copy_data.3http.adoc[`nng_http_res_copy_data()`].) This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final result -may be obtained via `<>`. +may be obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. === Persistent Connections @@ -49,8 +49,8 @@ of `Close` (case-insensitive) or the response corresponds to `HTTP/1.0`, then the connection is immediately after sending the response. NOTE: Consider using the -`<>` or -`<>` functions, +xref:nng_http_client_transact.3http.adoc[`nng_http_client_transact()`] or +xref:nng_http_conn_transact.3http.adoc[`nng_http_conn_transact()`] functions, which provide a simpler interface for performing a complete HTTP client transaction. @@ -71,11 +71,11 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_transact.3http.adoc[nng_http_client_transact(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng_http_conn_transact.3http.adoc[nng_http_conn_transact(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_handler_alloc.3http.adoc b/docs/man/nng_http_handler_alloc.3http.adoc index 139a24fae..6504212fa 100644 --- a/docs/man/nng_http_handler_alloc.3http.adoc +++ b/docs/man/nng_http_handler_alloc.3http.adoc @@ -52,49 +52,49 @@ considered when determining whether the handler should be called. Additionally each handler has a method it is registered to handle (the default is `GET`, see -`<>`), and +xref:nng_http_handler_set_method.3http.adoc[`nng_http_handler_set_method()`]), and optionally a 'Host' header it can be matched against (see -`<>`). +xref:nng_http_handler_set_host.3http.adoc[`nng_http_handler_set_host()`]). In some cases, a handler may reference a logical tree rather (directory) rather than just a single element. -(See `<>`). +(See xref:nng_http_handler_set_tree.3http.adoc[`nng_http_handler_set_tree()`]). === Custom Handler The generic (first) form of this creates a handler that uses a user-supplied function to process HTTP requests. This function uses the asynchronous I/O framework. -The function takes a pointer to an `<>` structure. +The function takes a pointer to an xref:nng_aio.5.adoc[`nng_aio`] structure. The _aio_ will be passed with the following input values (retrieved with -`<>`): +xref:nng_aio_get_input.3.adoc[`nng_aio_get_input()`]): 0: `nng_http_req *` __request__:: The client's HTTP request. 1: `nng_http_handler *` __handler__:: Pointer to the handler object. 2: `nng_http_conn *` __conn__:: The underlying HTTP connection. The handler should create an `nng_http_res *` response (such as via -`<>` or -`<>`) and store that +xref:nng_http_res_alloc.3http.adoc[`nng_http_res_alloc()`] or +xref:nng_http_res_alloc_error.3http.adoc[`nng_http_res_alloc_error()`]) and store that in as the first output (index 0) with -`<>`. +xref:nng_aio_set_output.3.adoc[`nng_aio_set_output()`]. Alternatively, the handler may send the HTTP response (and any associated body data) itself using the connection. In that case the output at index 0 of the _aio_ should be NULL. -Finally, using the `<>` function, the +Finally, using the xref:nng_aio_finish.3.adoc[`nng_aio_finish()`] function, the _aio_ should be completed successfully. If any non-zero status is returned back to the caller instead, then a generic 500 response will be created and sent, if possible, and the connection will be closed. The _aio_ may be scheduled for deferred completion using the -`<>` function. +xref:nng_aio_defer.3.adoc[`nng_aio_defer()`] function. NOTE: The callback function should *NOT* call -`<>`, +xref:nng_aio_begin.3.adoc[`nng_aio_begin()`], as that will already have been done by the server framework. === Directory Handler @@ -135,7 +135,7 @@ code such as 301, and a `Location:` header will contain the URL referenced by __location__, with any residual suffix from the request URI appended. -TIP: Use `<>` +TIP: Use xref:nng_http_handler_set_tree.3http.adoc[`nng_http_handler_set_tree()`] to redirect an entire tree. For example, it is possible to redirect an entire HTTP site to another HTTPS site by specifying `/` as the path and then using the base @@ -169,18 +169,18 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_defer.3.adoc[nng_aio_defer(3)], +xref:nng_aio_finish.3.adoc[nng_aio_finish(3)], +xref:nng_aio_get_input.3.adoc[nng_aio_get_input(3)], +xref:nng_aio_set_output.3.adoc[nng_aio_set_output(3)], +xref:nng_http_handler_collect_body.3http.adoc[nng_http_handler_collect_body(3http)], +xref:nng_http_handler_free.3http.adoc[nng_http_handler_free(3http)], +xref:nng_http_handler_set_host.3http.adoc[nng_http_handler_set_host(3http)], +xref:nng_http_handler_set_method.3http.adoc[nng_http_handler_set_method(3http)], +xref:nng_http_handler_set_tree.3http.adoc[nng_http_handler_set_tree(3http)], +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_alloc_error.3http.adoc[nng_http_res_alloc_error(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_handler_collect_body.3http.adoc b/docs/man/nng_http_handler_collect_body.3http.adoc index 273f8dc68..e969af8b3 100644 --- a/docs/man/nng_http_handler_collect_body.3http.adoc +++ b/docs/man/nng_http_handler_collect_body.3http.adoc @@ -30,7 +30,7 @@ collect any request body that was submitted with the request, and attach it to the `nng_http_req` before the handler is called. Subsequently the data can be retrieved by the handler from the request with the -`<>` function. +xref:nng_http_req_get_data.3http.adoc[`nng_http_req_get_data()`] function. The collection is enabled if _want_ is true. Furthermore, the data that the client may sent is limited by the @@ -72,7 +72,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng_http_req_get_data.3http.adoc[nng_http_req_get_data(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_handler_free.3http.adoc b/docs/man/nng_http_handler_free.3http.adoc index c45257034..c7b30e0e5 100644 --- a/docs/man/nng_http_handler_free.3http.adoc +++ b/docs/man/nng_http_handler_free.3http.adoc @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng.7.adoc[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 f7fcd6f5b..0467b2b68 100644 --- a/docs/man/nng_http_handler_get_data.3http.adoc +++ b/docs/man/nng_http_handler_get_data.3http.adoc @@ -27,7 +27,7 @@ void *nng_http_handler_get_data(nng_http_handler *handler); The `nng_http_handler_get_data()` function returns the data previously stored on _handler_ using the function -`<>`. +xref:nng_http_handler_set_data.3http.adoc[`nng_http_handler_set_data()`]. == RETURN VALUES @@ -40,7 +40,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_handler_set_data.3http.adoc[nng_http_server_set_data(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_handler_set_data.3http.adoc b/docs/man/nng_http_handler_set_data.3http.adoc index 9fd622b05..cb94adbc6 100644 --- a/docs/man/nng_http_handler_set_data.3http.adoc +++ b/docs/man/nng_http_handler_set_data.3http.adoc @@ -29,7 +29,7 @@ int nng_http_handler_set_data(nng_http_handler *handler, void *data, The `nng_http_handler_set_data()` function is used to set an additional _data_ for the _handler_. The stored _data_ can be retrieved later in the handler function using -`<>`. +xref:nng_http_handler_get_data.3http.adoc[`nng_http_handler_get_data()`]. Additionally, when the handler is deallocated, if _dtor_ is not `NULL`, then it will be called with _data_ as its argument. @@ -49,7 +49,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_handler_get_data.3http.adoc[nng_http_server_get_data(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_handler_set_host.3http.adoc b/docs/man/nng_http_handler_set_host.3http.adoc index 73cf3b934..0deae4888 100644 --- a/docs/man/nng_http_handler_set_host.3http.adoc +++ b/docs/man/nng_http_handler_set_host.3http.adoc @@ -54,6 +54,6 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng.7.adoc[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 852ddd513..f79f0faf7 100644 --- a/docs/man/nng_http_handler_set_method.3http.adoc +++ b/docs/man/nng_http_handler_set_method.3http.adoc @@ -40,7 +40,7 @@ NOTE: No validation of the _method_ is performed, but HTTP specifications insist that the actual method sent over the wire be capitalized. The handler may always examine the actual method used using the -`<>` function. +xref:nng_http_req_get_method.3http.adoc[`nng_http_req_get_method()`] function. == RETURN VALUES @@ -55,7 +55,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng_http_req_get_method.3http.adoc[nng_http_req_get_method(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_handler_set_tree.3http.adoc b/docs/man/nng_http_handler_set_tree.3http.adoc index 758240e3b..fc26ec704 100644 --- a/docs/man/nng_http_handler_set_tree.3http.adoc +++ b/docs/man/nng_http_handler_set_tree.3http.adoc @@ -45,7 +45,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng_http_req_get_method.3http.adoc[nng_http_req_get_method(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_hijack.3http.adoc b/docs/man/nng_http_hijack.3http.adoc index 1fd45f485..51231425d 100644 --- a/docs/man/nng_http_hijack.3http.adoc +++ b/docs/man/nng_http_hijack.3http.adoc @@ -33,13 +33,13 @@ WebSocket), where the underlying HTTP connection will be taken over for some other purpose, and should not be used any further by the server. This function is most useful when called from a handler function. -(See `<>`.) +(See xref:nng_http_handler_alloc.3http.adoc[`nng_http_handler_alloc()`].) 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. -(See `<>`.) +(See xref:nng_http_conn_write_res.3http.adoc[`nng_http_conn_write_res()`].) TIP: This function is intended to facilitate uses cases that involve changing the protocol from HTTP, such as WebSocket. @@ -59,7 +59,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res(3http)], +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_add_header.3http.adoc b/docs/man/nng_http_req_add_header.3http.adoc index bdfaccb37..bf95254a9 100644 --- a/docs/man/nng_http_req_add_header.3http.adoc +++ b/docs/man/nng_http_req_add_header.3http.adoc @@ -37,7 +37,7 @@ If no such header already exists, then one is created with the value _val_. TIP: The HTTP specification requires that duplicate headers be treated identically to a single header with multiple comma-delimited values. -TIP: See `<>` if +TIP: See xref:nng_http_req_set_header.3http.adoc[`nng_http_req_set_header()`] if replacement of an existing header rather than appending to it is desired. The value of _key_ is case insensitive, and should not include the final @@ -58,8 +58,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_del_header.3http.adoc[nng_http_req_del_header(3http)], +xref:nng_http_req_get_header.3http.adoc[nng_http_req_get_header(3http)], +xref:nng_http_req_set_header.3http.adoc[nng_http_req_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_alloc.3http.adoc b/docs/man/nng_http_req_alloc.3http.adoc index fe7458de3..706ef9d9a 100644 --- a/docs/man/nng_http_req_alloc.3http.adoc +++ b/docs/man/nng_http_req_alloc.3http.adoc @@ -32,7 +32,7 @@ to perform an HTTP/1.1 `GET` operation using the URL specified in __url__. TIP: It is possible to specify `NULL` for the URL. In this case the URI for the request must be specified by a subsequent call -to `<>`. +to xref:nng_http_req_set_uri.3http.adoc[`nng_http_req_set_uri()`]. == RETURN VALUES @@ -47,22 +47,22 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> -<>, -<> +xref:nng_http_conn_read_req.3http.adoc[nng_http_conn_read_req(3http)], +xref:nng_http_conn_write_req.3http.adoc[nng_http_conn_write_req(3http)], +xref:nng_http_req_add_header.3http.adoc[nng_http_req_add_header(3http)], +xref:nng_http_req_copy_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng_http_req_del_header.3http.adoc[nng_http_req_del_header(3http)], +xref:nng_http_req_free.3http.adoc[nng_http_req_free(3http)], +xref:nng_http_req_get_header.3http.adoc[nng_http_req_get_header(3http)], +xref:nng_http_req_get_method.3http.adoc[nng_http_req_get_method(3http)], +xref:nng_http_req_get_uri.3http.adoc[nng_http_req_get_uri(3http)], +xref:nng_http_req_get_version.3http.adoc[nng_http_req_get_version(3http)], +xref:nng_http_req_reset.3http.adoc[nng_http_req_reset(3http)], +xref:nng_http_req_set_data.3http.adoc[nng_http_req_set_data(3http)], +xref:nng_http_req_set_method.3http.adoc[nng_http_req_set_method(3http)], +xref:nng_http_req_set_uri.3http.adoc[nng_http_req_set_uri(3http)], +xref:nng_http_req_set_version.3http.adoc[nng_http_req_set_version(3http)], +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_url_parse.3.adoc[nng_url_parse(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_copy_data.3http.adoc b/docs/man/nng_http_req_copy_data.3http.adoc index 66562d8b0..7ab864fa3 100644 --- a/docs/man/nng_http_req_copy_data.3http.adoc +++ b/docs/man/nng_http_req_copy_data.3http.adoc @@ -30,7 +30,7 @@ and sets the HTTP body for the request _req_ to it. The copy will be deallocated automatically when _req_ is freed. The copied body data will be automatically sent with the request when it -is sent using `<>`. +is sent using xref:nng_http_conn_write_req.3http.adoc[`nng_http_conn_write_req()`]. This also updates the relevant `Content-Length` header of _req_. @@ -38,7 +38,7 @@ NOTE: The current framework does not support sending data via chunked transfer-encoding. TIP: To avoid copying data, the -`<>` may be used instead. +xref:nng_http_req_set_data.3http.adoc[`nng_http_req_set_data()`] may be used instead. TIP: It is a good idea to also set the `Content-Type` header. @@ -55,8 +55,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_conn_write_req.3http.adoc[nng_http_conn_write_req(3http)], +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_set_data.3http.adoc[nng_http_req_set_data(3http)], +xref:nng_http_req_set_header.3http.adoc[nng_http_req_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_del_header.3http.adoc b/docs/man/nng_http_req_del_header.3http.adoc index c4666570a..4ab973b09 100644 --- a/docs/man/nng_http_req_del_header.3http.adoc +++ b/docs/man/nng_http_req_del_header.3http.adoc @@ -46,8 +46,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_add_header.3http.adoc[nng_http_req_add_header(3http)], +xref:nng_http_req_del_header.3http.adoc[nng_http_req_del_header(3http)], +xref:nng_http_req_get_header.3http.adoc[nng_http_req_get_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_free.3http.adoc b/docs/man/nng_http_req_free.3http.adoc index 2564c4221..daa858b89 100644 --- a/docs/man/nng_http_req_free.3http.adoc +++ b/docs/man/nng_http_req_free.3http.adoc @@ -29,7 +29,7 @@ The `nng_http_req_free()` function deallocates the HTTP request structure _req_ entirely. TIP: Instead of freeing and reallocating request structures, it is possible -to reuse _req_ with `<>`. +to reuse _req_ with xref:nng_http_req_reset.3http.adoc[`nng_http_req_reset()`]. == RETURN VALUES @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_reset.3http.adoc[nng_http_req_reset(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_get_data.3http.adoc b/docs/man/nng_http_req_get_data.3http.adoc index cd5c076ef..e006bb1b8 100644 --- a/docs/man/nng_http_req_get_data.3http.adoc +++ b/docs/man/nng_http_req_get_data.3http.adoc @@ -44,7 +44,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_set_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng_http_req_copy_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng.7.adoc[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 8fbdb2b08..2b01f959d 100644 --- a/docs/man/nng_http_req_get_header.3http.adoc +++ b/docs/man/nng_http_req_get_header.3http.adoc @@ -46,7 +46,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_add_header.3http.adoc[nng_http_req_add_header(3http)], +xref:nng_http_req_set_header.3http.adoc[nng_http_req_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_get_method.3http.adoc b/docs/man/nng_http_req_get_method.3http.adoc index a9420c108..85e81278b 100644 --- a/docs/man/nng_http_req_get_method.3http.adoc +++ b/docs/man/nng_http_req_get_method.3http.adoc @@ -41,6 +41,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_set_method.3http.adoc[nng_http_req_set_method(3http)], +xref:nng.7.adoc[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 a5293b319..55463c780 100644 --- a/docs/man/nng_http_req_get_uri.3http.adoc +++ b/docs/man/nng_http_req_get_uri.3http.adoc @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_set_uri.3http.adoc[nng_http_req_set_uri(3http)], +xref:nng.7.adoc[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 9049d3f50..ef526df83 100644 --- a/docs/man/nng_http_req_get_version.3http.adoc +++ b/docs/man/nng_http_req_get_version.3http.adoc @@ -40,6 +40,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_set_version.3http.adoc[nng_http_req_set_version(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_reset.3http.adoc b/docs/man/nng_http_req_reset.3http.adoc index 9aab704aa..58dcc149c 100644 --- a/docs/man/nng_http_req_reset.3http.adoc +++ b/docs/man/nng_http_req_reset.3http.adoc @@ -27,10 +27,10 @@ void nng_http_req_reset(nng_http_req *req); The `nng_http_req_reset()` function resets the request __req__ so that it is just as if it had been freshly allocated with -`<>` with a `NULL` URL. +xref:nng_http_req_alloc.3http.adoc[`nng_http_req_alloc()`] with a `NULL` URL. NOTE: Before using this with an HTTP operation, the URI must be set using -`<>`. +xref:nng_http_req_set_uri.3http.adoc[`nng_http_req_set_uri()`]. == RETURN VALUES @@ -43,6 +43,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_set_uri.3http.adoc[nng_http_req_set_uri(3http)], +xref:nng.7.adoc[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 2e1631ae5..583d7a58f 100644 --- a/docs/man/nng_http_req_set_data.3http.adoc +++ b/docs/man/nng_http_req_set_data.3http.adoc @@ -28,7 +28,7 @@ int nng_http_req_set_data(nng_http_req *req, const void *body, size_t size); The `nng_http_req_set_data()` sets the HTTP body associated with the request _req_ to _body_, and the size of the body to _size_. This body data will be automatically sent with the request when it -is sent using `<>`. +is sent using xref:nng_http_conn_write_req.3http.adoc[`nng_http_conn_write_req()`]. This also updates the relevant `Content-Length` header of _req_. @@ -40,7 +40,7 @@ until the _req_ is deallocated. TIP: To have a local copy allocated with _req_ that will be automatically deallocated when _req_ is freed, -see `<>`. +see xref:nng_http_req_copy_data.3http.adoc[`nng_http_req_copy_data()`]. TIP: It is a good idea to also set the `Content-Type` header. @@ -57,8 +57,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_conn_write_req.3http.adoc[nng_http_conn_write_req(3http)], +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_copy_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng_http_req_set_header.3http.adoc[nng_http_req_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_set_header.3http.adoc b/docs/man/nng_http_req_set_header.3http.adoc index 04f736ef5..e38b56644 100644 --- a/docs/man/nng_http_req_set_header.3http.adoc +++ b/docs/man/nng_http_req_set_header.3http.adoc @@ -31,7 +31,7 @@ _req_ and the _key_ to the _val_. The _key_ and _val_ are copied. Any previous header with the same _key_ is replaced. -TIP: See `<>` to +TIP: See xref:nng_http_req_add_header.3http.adoc[`nng_http_req_add_header()`] to add additional headers with the same _key_ without replacing them. The value of _key_ is case insensitive, and should not include the final @@ -52,8 +52,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_add_header.3http.adoc[nng_http_req_add_header(3http)], +xref:nng_http_req_del_header.3http.adoc[nng_http_req_del_header(3http)], +xref:nng_http_req_get_header.3http.adoc[nng_http_req_get_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_set_method.3http.adoc b/docs/man/nng_http_req_set_method.3http.adoc index 5cb149265..bc80b8328 100644 --- a/docs/man/nng_http_req_set_method.3http.adoc +++ b/docs/man/nng_http_req_set_method.3http.adoc @@ -47,6 +47,6 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_get_method.3http.adoc[nng_http_req_get_method(3http)], +xref:nng.7.adoc[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 bd3cb5867..fd6961d68 100644 --- a/docs/man/nng_http_req_set_uri.3http.adoc +++ b/docs/man/nng_http_req_set_uri.3http.adoc @@ -35,7 +35,7 @@ A local copy of the _uri_ is made in the request _req_. NOTE: No validation or canonicalization of the _uri_ is performed. -TIP: The `<>` function can be used to +TIP: The xref:nng_url_parse.3.adoc[`nng_url_parse()`] function can be used to perform validation and canonicalization. The `u_requri` member will contain a suitable value that can be used with this function. @@ -53,7 +53,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_get_uri.3http.adoc[nng_http_req_get_uri(3http)], +xref:nng_url_parse.3.adoc[nng_url_parse(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_req_set_version.3http.adoc b/docs/man/nng_http_req_set_version.3http.adoc index 24f9ace57..04fd1b0d9 100644 --- a/docs/man/nng_http_req_set_version.3http.adoc +++ b/docs/man/nng_http_req_set_version.3http.adoc @@ -53,6 +53,6 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_req_get_version.3http.adoc[nng_http_req_get_version(3http)], +xref:nng.7.adoc[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 8c6dfcf0a..eb2a79c1a 100644 --- a/docs/man/nng_http_res_add_header.3http.adoc +++ b/docs/man/nng_http_res_add_header.3http.adoc @@ -38,7 +38,7 @@ If no such header already exists, then one is created with the value _val_. TIP: The HTTP specification requires that duplicate headers be treated identically to a single header with multiple comma-delimited values. -TIP: See `<>` if +TIP: See xref:nng_http_res_set_header.3http.adoc[`nng_http_res_set_header()`] if replacement of an existing header rather than appending to it is desired. The value of _key_ is case insensitive, and should not include the final @@ -58,8 +58,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_del_header.3http.adoc[nng_http_res_del_header(3http)], +xref:nng_http_res_get_header.3http.adoc[nng_http_res_get_header(3http)], +xref:nng_http_res_set_header.3http.adoc[nng_http_res_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_alloc.3http.adoc b/docs/man/nng_http_res_alloc.3http.adoc index b395b5025..ba2c9b5f4 100644 --- a/docs/man/nng_http_res_alloc.3http.adoc +++ b/docs/man/nng_http_res_alloc.3http.adoc @@ -32,7 +32,7 @@ with status code 200 (`NNG_HTTP_STATUS_OK`), and a reason phrase of `"OK`", and HTTP protocol version `"HTTP/1.1`". TIP: When an error response is needed, consider using -`<>` instead. +xref:nng_http_res_alloc_error.3http.adoc[`nng_http_res_alloc_error()`] instead. == RETURN VALUES @@ -47,22 +47,22 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_conn_read_res.3http.adoc[nng_http_conn_read_res(3http)], +xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res(3http)], +xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_res_alloc_error.3http.adoc[nng_http_res_alloc_error(3http)], +xref:nng_http_res_add_header.3http.adoc[nng_http_res_add_header(3http)], +xref:nng_http_res_copy_data.3http.adoc[nng_http_res_copy_data(3http)], +xref:nng_http_res_del_header.3http.adoc[nng_http_res_del_header(3http)], +xref:nng_http_res_free.3http.adoc[nng_http_res_free(3http)], +xref:nng_http_res_get_header.3http.adoc[nng_http_res_get_header(3http)], +xref:nng_http_res_get_reason.3http.adoc[nng_http_res_get_reason(3http)], +xref:nng_http_res_get_status.3http.adoc[nng_http_res_get_status(3http)], +xref:nng_http_res_get_version.3http.adoc[nng_http_res_get_version(3http)], +xref:nng_http_res_reset.3http.adoc[nng_http_res_reset(3http)], +xref:nng_http_res_set_data.3http.adoc[nng_http_res_set_data(3http)], +xref:nng_http_res_set_reason.3http.adoc[nng_http_res_set_reason(3http)], +xref:nng_http_res_set_status.3http.adoc[nng_http_res_set_status(3http)], +xref:nng_http_res_set_version.3http.adoc[nng_http_res_set_version(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_alloc_error.3http.adoc b/docs/man/nng_http_res_alloc_error.3http.adoc index f3d54bc49..2c8d729f4 100644 --- a/docs/man/nng_http_res_alloc_error.3http.adoc +++ b/docs/man/nng_http_res_alloc_error.3http.adoc @@ -50,9 +50,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_free.3http.adoc[nng_http_res_free(3http)], +xref:nng_http_res_set_reason.3http.adoc[nng_http_res_set_reason(3http)], +xref:nng_http_res_set_status.3http.adoc[nng_http_res_set_status(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_copy_data.3http.adoc b/docs/man/nng_http_res_copy_data.3http.adoc index e36fb58e4..b2cea28ae 100644 --- a/docs/man/nng_http_res_copy_data.3http.adoc +++ b/docs/man/nng_http_res_copy_data.3http.adoc @@ -30,7 +30,7 @@ and sets the HTTP body for the response _res_ to it. The copy will be deallocated automatically when _res_ is freed. The copied body data will be automatically sent with the response when it -is sent using `<>`. +is sent using xref:nng_http_conn_write_res.3http.adoc[`nng_http_conn_write_res()`]. This also updates the relevant `Content-Length` header of _res_. @@ -38,7 +38,7 @@ NOTE: The current framework does not support sending data via chunked transfer-encoding. TIP: To avoid copying data, the -`<>` may be used instead. +xref:nng_http_res_set_data.3http.adoc[`nng_http_res_set_data()`] may be used instead. TIP: It is a good idea to also set the `Content-Type` header. @@ -55,8 +55,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res(3http)], +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_set_data.3http.adoc[nng_http_res_set_data(3http)], +xref:nng_http_res_set_header.3http.adoc[nng_http_res_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_del_header.3http.adoc b/docs/man/nng_http_res_del_header.3http.adoc index 9fda3bcdd..803dc657d 100644 --- a/docs/man/nng_http_res_del_header.3http.adoc +++ b/docs/man/nng_http_res_del_header.3http.adoc @@ -45,8 +45,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_add_header.3http.adoc[nng_http_res_add_header(3http)], +xref:nng_http_res_del_header.3http.adoc[nng_http_res_del_header(3http)], +xref:nng_http_res_get_header.3http.adoc[nng_http_res_get_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_free.3http.adoc b/docs/man/nng_http_res_free.3http.adoc index e97f0be6b..c278648c9 100644 --- a/docs/man/nng_http_res_free.3http.adoc +++ b/docs/man/nng_http_res_free.3http.adoc @@ -29,7 +29,7 @@ The `nng_http_res_free()` function deallocates the HTTP response structure _res_ entirely. TIP: Instead of freeing and reallocating response structures, it is possible -to reuse _res_ with `<>`. +to reuse _res_ with xref:nng_http_res_reset.3http.adoc[`nng_http_res_reset()`]. == RETURN VALUES @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_reset.3http.adoc[nng_http_res_reset(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_get_data.3http.adoc b/docs/man/nng_http_res_get_data.3http.adoc index 44f98c1fe..374bce704 100644 --- a/docs/man/nng_http_res_get_data.3http.adoc +++ b/docs/man/nng_http_res_get_data.3http.adoc @@ -44,7 +44,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_req_alloc(3http)], +xref:nng_http_res_set_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng_http_res_copy_data.3http.adoc[nng_http_req_copy_data(3http)], +xref:nng.7.adoc[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 936d7d3fd..34c5b0150 100644 --- a/docs/man/nng_http_res_get_header.3http.adoc +++ b/docs/man/nng_http_res_get_header.3http.adoc @@ -46,7 +46,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_add_header.3http.adoc[nng_http_res_add_header(3http)], +xref:nng_http_res_set_header.3http.adoc[nng_http_res_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_get_reason.3http.adoc b/docs/man/nng_http_res_get_reason.3http.adoc index 70d5f1e3b..3ac05bcba 100644 --- a/docs/man/nng_http_res_get_reason.3http.adoc +++ b/docs/man/nng_http_res_get_reason.3http.adoc @@ -29,7 +29,7 @@ The `nng_http_res_get_reason()` returns a string representing the "`reason phrase`" associated with the response _res_. This is a human-readable explanation of the status code that would be obtained from -`<>`. +xref:nng_http_res_get_status.3http.adoc[`nng_http_res_get_status()`]. == RETURN VALUES @@ -42,7 +42,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_get_status.3http.adoc[nng_http_res_get_status(3http)], +xref:nng_http_res_set_reason.3http.adoc[nng_http_res_set_reason(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_get_status.3http.adoc b/docs/man/nng_http_res_get_status.3http.adoc index 2475c76f1..d8c79ed52 100644 --- a/docs/man/nng_http_res_get_status.3http.adoc +++ b/docs/man/nng_http_res_get_status.3http.adoc @@ -98,7 +98,7 @@ enum { TIP: When displaying status information to users (or logging such information), consider also including the "`reason phrase`" obtained with -`<>`. +xref:nng_http_res_get_reason.3http.adoc[`nng_http_res_get_reason()`]. == RETURN VALUES @@ -111,7 +111,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_get_reason.3http.adoc[nng_http_res_get_reason(3http)], +xref:nng_http_res_set_status.3http.adoc[nng_http_res_set_status(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_get_version.3http.adoc b/docs/man/nng_http_res_get_version.3http.adoc index 17dbdfec6..d69e387cd 100644 --- a/docs/man/nng_http_res_get_version.3http.adoc +++ b/docs/man/nng_http_res_get_version.3http.adoc @@ -40,6 +40,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_set_version.3http.adoc[nng_http_res_set_version(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_reset.3http.adoc b/docs/man/nng_http_res_reset.3http.adoc index f33a02072..f78d29a23 100644 --- a/docs/man/nng_http_res_reset.3http.adoc +++ b/docs/man/nng_http_res_reset.3http.adoc @@ -27,7 +27,7 @@ void nng_http_res_reset(nng_http_res *res); The `nng_http_res_reset()` function resets the response __res__ so that it is just as if it had been freshly allocated with -`<>`. +xref:nng_http_res_alloc.3http.adoc[`nng_http_res_alloc()`]. == RETURN VALUES @@ -40,5 +40,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng.7.adoc[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 8202ec612..7c4c06bcb 100644 --- a/docs/man/nng_http_res_set_data.3http.adoc +++ b/docs/man/nng_http_res_set_data.3http.adoc @@ -28,7 +28,7 @@ int nng_http_res_set_data(nng_http_res *res, const void *body, size_t size); The `nng_http_res_set_data()` sets the HTTP body associated with the response _res_ to _body_, and the size of the body to _size_. This body data will be automatically sent with the response when it -is sent using `<>`. +is sent using xref:nng_http_conn_write_res.3http.adoc[`nng_http_conn_write_res()`]. This also updates the relevant `Content-Length` header of _res_. @@ -40,7 +40,7 @@ until the _res_ is deallocated. TIP: To have a local copy allocated with _res_ that will be automatically deallocated when _res_ is freed, -see `<>`. +see xref:nng_http_res_copy_data.3http.adoc[`nng_http_res_copy_data()`]. TIP: It is a good idea to also set the `Content-Type` header. @@ -57,8 +57,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res(3http)], +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_copy_data.3http.adoc[nng_http_res_copy_data(3http)], +xref:nng_http_res_set_header.3http.adoc[nng_http_res_set_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_set_header.3http.adoc b/docs/man/nng_http_res_set_header.3http.adoc index 512658127..2ad4282e4 100644 --- a/docs/man/nng_http_res_set_header.3http.adoc +++ b/docs/man/nng_http_res_set_header.3http.adoc @@ -31,7 +31,7 @@ _res_ and the _key_ to the _val_. The _key_ and _val_ are copied. Any previous header with the same _key_ is replaced. -TIP: See `<>` to +TIP: See xref:nng_http_res_add_header.3http.adoc[`nng_http_res_add_header()`] to add additional headers with the same _key_ without replacing them. The value of _key_ is case insensitive, and should not include the final @@ -52,8 +52,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_add_header.3http.adoc[nng_http_res_add_header(3http)], +xref:nng_http_res_del_header.3http.adoc[nng_http_res_del_header(3http)], +xref:nng_http_res_get_header.3http.adoc[nng_http_res_get_header(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_set_reason.3http.adoc b/docs/man/nng_http_res_set_reason.3http.adoc index 804b951b9..28a644973 100644 --- a/docs/man/nng_http_res_set_reason.3http.adoc +++ b/docs/man/nng_http_res_set_reason.3http.adoc @@ -30,7 +30,7 @@ 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 -`<>`). +xref:nng_http_res_set_status.3http.adoc[`nng_http_res_set_status()`]). TIP: The _reason_ is never parsed automatically, but it can be a hint for humans to help them understand the nature of any erroneous result. @@ -50,7 +50,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_get_reason.3http.adoc[nng_http_req_get_reason(3http)], +xref:nng_http_res_set_status.3http.adoc[nng_http_req_set_status(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_set_status.3http.adoc b/docs/man/nng_http_res_set_status.3http.adoc index cf08d2cb1..2083c3b74 100644 --- a/docs/man/nng_http_res_set_status.3http.adoc +++ b/docs/man/nng_http_res_set_status.3http.adoc @@ -103,7 +103,7 @@ Please see the relevant HTTP RFCs for the semantics and correct use of these status codes. TIP: It is a good idea to also set the "`reason phrase`" with -`<>`. +xref:nng_http_res_set_reason.3http.adoc[`nng_http_set_reason()`]. This will help any humans who may have to diagnose a failure. == RETURN VALUES @@ -118,7 +118,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_res_get_status.3http.adoc[nng_http_req_get_status(3http)], +xref:nng_http_res_set_reason.3http.adoc[nng_http_req_set_reason(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_res_set_version.3http.adoc b/docs/man/nng_http_res_set_version.3http.adoc index 38344690d..23c25312b 100644 --- a/docs/man/nng_http_res_set_version.3http.adoc +++ b/docs/man/nng_http_res_set_version.3http.adoc @@ -53,6 +53,6 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)], +xref:nng_http_req_get_version.3http.adoc[nng_http_req_get_version(3http)], +xref:nng.7.adoc[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 ff2dee2a9..5b5c474b6 100644 --- a/docs/man/nng_http_server_add_handler.3http.adoc +++ b/docs/man/nng_http_server_add_handler.3http.adoc @@ -35,7 +35,7 @@ If a handler is added to a server, and the server is subsequently deallocated, the handler and any of its resources will also be deallocated. Handlers that are added to a server may be subsequently removed using the -`<>` function. +xref:nng_http_server_del_handler.3http.adoc[`nng_http_server_del_handler()`] function. == RETURN VALUES @@ -52,8 +52,8 @@ This function returns 0 on success, and non-zero otherwise. [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_server_del_handler.3http.adoc[nng_http_server_del_handler(3http)], +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_del_handler.3http.adoc b/docs/man/nng_http_server_del_handler.3http.adoc index a90517c50..4ff89f7df 100644 --- a/docs/man/nng_http_server_del_handler.3http.adoc +++ b/docs/man/nng_http_server_del_handler.3http.adoc @@ -44,7 +44,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_handler_free.3http.adoc[nng_http_handler_free(3http)], +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_get_tls.3http.adoc b/docs/man/nng_http_server_get_tls.3http.adoc index e252f46c8..51bc72180 100644 --- a/docs/man/nng_http_server_get_tls.3http.adoc +++ b/docs/man/nng_http_server_get_tls.3http.adoc @@ -29,10 +29,10 @@ The `nng_http_server_get_tls()` obtains the TLS configuration of server _s_ and saves a pointer to it in the address referenced by _cfgp_. The object will be returned with an extra hold (see -`<>`) +xref:nng_tls_config_hold.3tls.adoc[`nng_tls_config_hold()`]) placed on it on behalf of the caller. The caller should free this hold by calling -`<>` with it is done +xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`] with it is done with the TLS configuration. == RETURN VALUES @@ -49,11 +49,11 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_set_tls.3http.adoc[nng_http_server_set_tls(3http)], +xref:nng_http_server_start.3http.adoc[nng_http_server_start(3http)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_free.3tls.adoc[nng_tls_config_free(3tls)], +xref:nng_tls_config_hold.3tls.adoc[nng_tls_config_hold(3tls)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_hold.3http.adoc b/docs/man/nng_http_server_hold.3http.adoc index f7e11b4bd..0111d43f6 100644 --- a/docs/man/nng_http_server_hold.3http.adoc +++ b/docs/man/nng_http_server_hold.3http.adoc @@ -37,7 +37,7 @@ with an initial reference count of one (1). The server instance is not started, and can have additional configuration applied to it before it is later started with -`<>`. +xref:nng_http_server_start.3http.adoc[`nng_http_server_start()`]. NOTE: The URL matching logic in determining servers is unable to distinguish between different aliases for the same local IP address. @@ -58,9 +58,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> -<>, -<> +xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], +xref:nng_http_server_release.3http.adoc[nng_http_server_release(3http)], +xref:nng_http_server_stop.3http.adoc[nng_http_server_stop(3http)], +xref:nng_url_parse.3.adoc[nng_url_parse(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_release.3http.adoc b/docs/man/nng_http_server_release.3http.adoc index 62aff7525..0d9191917 100644 --- a/docs/man/nng_http_server_release.3http.adoc +++ b/docs/man/nng_http_server_release.3http.adoc @@ -27,7 +27,7 @@ void nng_http_server_release(nng_http_server *server); The `nng_http_server_release()` releases an instance of an HTTP _server_ that was previously held with -`<>`. +xref:nng_http_server_hold.3http.adoc[`nng_http_server_hold()`]. This effectively drops the reference count on the server instance. When the reference count drops to zero, then the _server_ and all resources @@ -49,6 +49,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_stop.3http.adoc[nng_http_server_stop(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_res_error.3http.adoc b/docs/man/nng_http_server_res_error.3http.adoc index c1ab7f51d..b669a0617 100644 --- a/docs/man/nng_http_server_res_error.3http.adoc +++ b/docs/man/nng_http_server_res_error.3http.adoc @@ -28,16 +28,16 @@ int nng_http_server_res_error(nng_http_server *server, The `nng_http_server_res_error()` sets the body of _response_ to _server_'s error page, which may have been customized using the -`<>` +xref:nng_http_server_set_error_file.3http.adoc[`nng_http_server_error_file()`] or -`<>` +xref:nng_http_server_set_error_page.3http.adoc[`nng_http_server_error_page()`] functions. The status code of the _response_ should have already been set, either implicitly by allocating it with -`<>`, +xref:nng_http_res_alloc_error.3http.adoc[`nng_http_res_alloc_error()`], or by calling -`<>`. +xref:nng_http_res_set_status.3http.adoc[`nng_http_res_set_status()`]. Any content body previously set for _response_ will be overridden by this function. @@ -55,9 +55,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc_error.3http.adoc[nng_http_res_alloc_error(3http)], +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_set_error_file.3http.adoc[nng_http_server_set_error_file(3http)], +xref:nng_http_server_set_error_page.3http.adoc[nng_http_server_set_error_page(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_set_error_file.3http.adoc b/docs/man/nng_http_server_set_error_file.3http.adoc index dde8d9800..ac38f6f96 100644 --- a/docs/man/nng_http_server_set_error_file.3http.adoc +++ b/docs/man/nng_http_server_set_error_file.3http.adoc @@ -34,12 +34,12 @@ the file located at _path_, which should be an HTML file. The custom HTML content will be used when the server is returning an internally generated error response, or is returning an error response that was allocated with the -`<>` +xref:nng_http_res_alloc_error.3http.adoc[`nng_http_res_alloc_error()`] function. This HTML content will also be used if the application calls the -`<>`. +xref:nng_http_server_res_error.3http.adoc[`nng_http_server_res_error()`]. The last custom error page set for _code_ by either this function or -`<>` +xref:`nng_http_server_set_error_page.3http.adoc[`nng_http_server_error_page()`] will be used. NOTE: Error responses that have their body content changed after allocation, @@ -65,9 +65,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc_error.3http.adoc[nng_http_res_alloc_error(3http)], +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_res_error.3http.adoc[nng_http_server_res_error(3http)], +xref:nng_http_server_set_error_page.3http.adoc[nng_http_server_set_error_page(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_set_error_page.3http.adoc b/docs/man/nng_http_server_set_error_page.3http.adoc index 271b9d996..d3b136d5b 100644 --- a/docs/man/nng_http_server_set_error_page.3http.adoc +++ b/docs/man/nng_http_server_set_error_page.3http.adoc @@ -33,12 +33,12 @@ The body content of the HTTP responses will contain _html_. The custom HTML content will be used when the server is returning an internally generated error response, or is returning an error response that was allocated with the -`<>` +xref:nng_http_res_alloc_error.3http.adoc[`nng_http_res_alloc_error()`] function. This HTML content will also be used if the application calls the -`<>`. +xref:nng_http_server_res_error.3http.adoc[`nng_http_server_res_error()`]. The last custom error page set for _code_ by either this function or -`<>` +xref:nng_http_server_set_error_file.3http.adoc[`nng_http_server_error_file()`] will be used. NOTE: Error responses that have their body content changed after allocation, @@ -61,9 +61,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_res_alloc_error.3http.adoc[nng_http_res_alloc_error(3http)], +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_res_error.3http.adoc[nng_http_server_res_error(3http)], +xref:nng_http_server_set_error_file.3http.adoc[nng_http_server_set_error_file(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[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 ed42353e9..1fe8eaa14 100644 --- a/docs/man/nng_http_server_set_tls.3http.adoc +++ b/docs/man/nng_http_server_set_tls.3http.adoc @@ -31,14 +31,14 @@ _cfg_. This change overwrites any previous TLS configuration. IMPORTANT: This also invalidates any previously obtained values from -`<>`. +xref:nng_http_server_get_tls.3http.adoc[`nng_http_server_get_tls()`]. If the server is already running (i.e. it has been started with -`<>`) then this will +xref:nng_http_server_start.3http.adoc[`nng_http_server_start()`]) then this will fail with `NNG_EBUSY`. TIP: Generally, the _cfg_ must have a configured private key, set with -`<>` or similar. +xref:nng_tls_config_own_cert.3tls.adoc[`nng_tls_config_own_cert()`] or similar. == RETURN VALUES @@ -54,9 +54,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_http_server_get_tls.3http.adoc[nng_http_server_get_tls(3http)], +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_start.3http.adoc[nng_http_server_start(3http)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_start.3http.adoc b/docs/man/nng_http_server_start.3http.adoc index c8b7b5421..31e0f3254 100644 --- a/docs/man/nng_http_server_start.3http.adoc +++ b/docs/man/nng_http_server_start.3http.adoc @@ -44,9 +44,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> -<>, -<> +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_release.3http.adoc[nng_http_server_release(3http)], +xref:nng_http_server_stop.3http.adoc[nng_http_server_stop(3http)], +xref:nng_url_parse.3.adoc[nng_url_parse(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_server_stop.3http.adoc b/docs/man/nng_http_server_stop.3http.adoc index 8082409c4..098d7bdfb 100644 --- a/docs/man/nng_http_server_stop.3http.adoc +++ b/docs/man/nng_http_server_stop.3http.adoc @@ -26,10 +26,10 @@ void nng_http_server_stop(nng_http_server *server); == DESCRIPTION The `nng_http_server_stop()` undoes the effect of -`<>`. +xref:nng_http_server_start.3http.adoc[`nng_http_server_start()`]. Each call by -`<>` acts as reference +xref:nng_http_server_start.3http.adoc[`nng_http_server_start()`] acts as reference count, and should be matched by a call to `nng_http_server_stop()`. When the reference count drops to zero, then the server is actually stopped, and existing open connections to it are closed. @@ -37,10 +37,10 @@ and existing open connections to it are closed. This function does not wait for the connections to close. NOTE: Once the server instance is actually stopped, it cannot be started again, -and any future calls to `<>` +and any future calls to xref:nng_http_server_hold.3http.adoc[`nng_http_server_hold()`] will return a new instance of the server. It is expected that the caller will follow this function call with a call to -`<>`. +xref:nng_http_server_release.3http.adoc[`nng_http_server_release()`]. == RETURN VALUES @@ -54,7 +54,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_http_server_hold.3http.adoc[nng_http_server_hold(3http)], +xref:nng_http_server_release.3http.adoc[nng_http_server_release(3http)], +xref:nng_http_server_start.3http.adoc[nng_http_server_start(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_inproc_register.3.adoc b/docs/man/nng_inproc_register.3.adoc index 2f0bcba53..cf9afce2f 100644 --- a/docs/man/nng_inproc_register.3.adoc +++ b/docs/man/nng_inproc_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> +xref:nng_inproc.7.adoc[nng_inproc(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_iov.5.adoc b/docs/man/nng_iov.5.adoc index 30681185f..5c3e3c407 100644 --- a/docs/man/nng_iov.5.adoc +++ b/docs/man/nng_iov.5.adoc @@ -35,8 +35,8 @@ For example, it may be useful to send a message with header data from one part of memory, and a user payload from another. The operations that do this typically store an array of these in -an `<>` structure using the -`<>` function. +an xref:nng_aio.5.adoc[`nng_aio`] structure using the +xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function. The following structure members are present: @@ -50,6 +50,6 @@ The following structure members are present: == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ipc.7.adoc b/docs/man/nng_ipc.7.adoc index eeaf53186..049047297 100644 --- a/docs/man/nng_ipc.7.adoc +++ b/docs/man/nng_ipc.7.adoc @@ -65,28 +65,28 @@ longer than 128 bytes, including the `ipc://` prefix. === Socket Address -When using an <> structure, -the actual structure is of type <>. +When using an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure, +the actual structure is of type xref:nng_sockaddr_ipc.5.adoc[`nng_sockaddr_ipc`]. === Transport Options The following transport options are supported by this transport, where supported by the underlying platform. -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> +* xref:nng_ipc_options.5.adoc#NNG_OPT_IPC_PEER_GID[`NNG_OPT_IPC_PEER_GID`] +* xref:nng_ipc_options.5.adoc#NNG_OPT_IPC_PEER_PID[`NNG_OPT_IPC_PEER_PID`] +* xref:nng_ipc_options.5.adoc#NNG_OPT_IPC_PEER_UID[`NNG_OPT_IPC_PEER_UID`] +* xref:nng_ipc_options.5.adoc#NNG_OPT_IPC_PEER_ZONEID[`NNG_OPT_IPC_PEER_ZONEID`] +* xref:nng_ipc_options.5.adoc#NNG_OPT_IPC_PERMISSIONS[`NNG_OPT_IPC_PERMISSIONS`] +* xref:nng_ipc_options.5.adoc#NNG_OPT_IPC_SECURITY_DESCRIPTOR[`NNG_OPT_IPC_SECURITY_DESCRIPTOR`] +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_options.5.adoc#NNG_OPT_URL[`NNG_OPT_URL`] == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_ipc_options.5.adoc[nng_ipc_options(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ipc_options.5.adoc b/docs/man/nng_ipc_options.5.adoc index ab00b9933..207986906 100644 --- a/docs/man/nng_ipc_options.5.adoc +++ b/docs/man/nng_ipc_options.5.adoc @@ -120,17 +120,17 @@ applied to listeners that have not been started yet. Generally, the following option values are also available for TLS objects, when appropriate for the context: -* <> -* <> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> -<> +xref:nng_ipc_dialer_getopt.3ipc.adoc[nng_ipc_dialer_getopt(3ipc)], +xref:nng_ipc_dialer_setopt.3ipc.adoc[nng_ipc_dialer_setopt(3ipc)], +xref:nng_ipc_getopt.3ipc.adoc[nng_ipc_getopt(3ipc)], +xref:nng_ipc_listener_getopt.3ipc.adoc[nng_ipc_listener_getopt(3ipc)], +xref:nng_ipc_listener_setopt.3ipc.adoc[nng_ipc_listener_setopt(3ipc)], +xref:nng_ipc_setopt.3ipc.adoc[nng_ipc_setopt(3ipc)], +xref:nng_options.5.adoc[nng_options(5)] +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ipc_register.3.adoc b/docs/man/nng_ipc_register.3.adoc index e0fd514c0..cfdf823a9 100644 --- a/docs/man/nng_ipc_register.3.adoc +++ b/docs/man/nng_ipc_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> +xref:nng_ipc.7.adoc[nng_ipc(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listen.3.adoc b/docs/man/nng_listen.3.adoc index e569da4f2..4b120ecb5 100644 --- a/docs/man/nng_listen.3.adoc +++ b/docs/man/nng_listen.3.adoc @@ -25,14 +25,14 @@ int nng_listen(nng_socket s, const char *url, nng_listener *lp, int flags); == DESCRIPTION The `nng_listen()` function creates a newly initialized -`<>` object, associated with socket _s_, +xref:nng_listener.5.adoc[`nng_listener`] object, associated with socket _s_, and configured to listen at the address specified by _url_, and starts it. If the value of _lp_ is not `NULL`, then the newly created listener is stored at the address indicated by _lp_. Listeners are used to accept connections initiated by remote dialers. An incoming connection generally results in and -`<>` object being created and attached to the socket _s_. +xref:nng_pipe.5.adoc[`nng_pipe`] object being created and attached to the socket _s_. Unlike dialers, listeners generally can create many pipes, which may be open concurrently. @@ -41,14 +41,14 @@ The _flags_ argument is ignored, but reserved for future use. TIP: While it is convenient to think of listeners as "`servers`", the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. -For example, a <> +For example, a xref:nng_req.7.adoc[_req_] socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! Because the listener is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using `<>` and -`<>` instead. +using xref:nng_listener_create.3.adoc[`nng_listener_create()`] and +xref:nng_listener_start.3.adoc[`nng_listener_start()`] instead. The created listener will continue to accept new connections, associating their pipes with the socket, until either it or the socket _s_ is closed. @@ -69,10 +69,10 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> -<>, -<>, -<>, -<> +xref:nng_dial.3.adoc[nng_dial(3)], +xref:nng_listener_close.3.adoc[nng_listener_close(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_listener_start.3.adoc[nng_listener_start(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener.5.adoc b/docs/man/nng_listener.5.adoc index 6df0f5f18..d481b2ce7 100644 --- a/docs/man/nng_listener.5.adoc +++ b/docs/man/nng_listener.5.adoc @@ -26,33 +26,33 @@ typedef struct nng_listener_s nng_listener; (((listener))) An `nng_listener` is a handle to a "`listener`" object, which is responsible for -creating `<>` objects by accepting incoming connections. +creating xref:nng_pipe.5.adoc[`nng_pipe`] objects by accepting incoming connections. A given listener object may create many pipes at the same time, much like an HTTP server can have many connections to multiple clients simultaneously. Listener objects are created by the -`<>` -or `<>` functions, and are always "`owned`" -by a single `<>`. +xref:nng_listener_create.3.adoc[`nng_listener_create()`] +or xref:nng_listen.3.adoc[`nng_listen()`] functions, and are always "`owned`" +by a single xref:nng_socket.5.adoc[`nng_socket`]. IMPORTANT: The `nng_listener` structure is always passed by value (both 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: A given `<>` may have multiple listener -objects, multiple <> objects, or even some +TIP: A given xref:nng_socket.5.adoc[`nng_socket`] may have multiple listener +objects, multiple xref:nng_dialer.5.adoc[dialer] objects, or even some of both. TIP: The client/server relationship described by dialer/listener is completely orthogonal to any similar relationship in the protocols. -For example, a <> socket may use a dialer -to connect to a listener on an <> socket. +For example, a xref:nng_rep.7.adoc[_rep_] socket may use a dialer +to connect to a listener on an xref:nng_req.7.adoc[_req_] socket. This orthogonality can lead to innovative solutions to otherwise challenging communications problems. Listener objects may be destroyed by the -`<>` function. +xref:nng_listener_close.3.adoc[`nng_listener_close()`] function. They are also closed when their "`owning`" socket is closed. [[NNG_LISTENER_INITIALIZER]] @@ -64,14 +64,14 @@ before it is opened, to prevent confusion with valid open listener. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_close.3.adoc[nng_listener_close(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)], +xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)], +xref:nng_listener_id.3.adoc[nng_listener_id(3)], +xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)], +xref:nng_listener_start.3.adoc[nng_listener_start(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_close.3.adoc b/docs/man/nng_listener_close.3.adoc index 9411a01b5..239fe26b0 100644 --- a/docs/man/nng_listener_close.3.adoc +++ b/docs/man/nng_listener_close.3.adoc @@ -48,9 +48,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> -<>, -<>, -<> +xref:nng_close.3.adoc[nng_close(3)], +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_create.3.adoc b/docs/man/nng_listener_create.3.adoc index 059a481f5..0d766cc30 100644 --- a/docs/man/nng_listener_create.3.adoc +++ b/docs/man/nng_listener_create.3.adoc @@ -25,7 +25,7 @@ int nng_listener_create(nng_listener *listenerp, nng_socket s, const char *url); == DESCRIPTION The `nng_listener_create()` function creates a newly initialized -`<>` object, associated with socket _s_, +xref:nng_listener.5.adoc[`nng_listener`] object, associated with socket _s_, and configured to listen at the address specified by _url_, and stores a pointer to at the location referenced by _listenerp_. @@ -38,19 +38,19 @@ which may be open concurrently. TIP: While it is convenient to think of listeners as "`servers`", the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. -For example, a <> socket might have associated dialers, +For example, a xref:nng_req.7.adoc[_req_] socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! The listener is not started, but may be further configured with -the `<>` family of +the xref:nng_listener_setopt.3.adoc[`nng_listener_setopt()`] family of functions. Once it is fully configured, the listener may be started using the -`<>` function. +xref:nng_listener_start.3.adoc[`nng_listener_start()`] function. TIP: If no specific configuration is required, consider using the -simpler `<>` function instead. +simpler xref:nng_listen.3.adoc[`nng_listen()`] function instead. == RETURN VALUES @@ -66,12 +66,12 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<> -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_close.3.adoc[nng_listener_close(3)], +xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)], +xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)], +xref:nng_listener_start.3.adoc[nng_listener_start(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_get.3.adoc b/docs/man/nng_listener_get.3.adoc index 4c74fa5de..bd59ffa38 100644 --- a/docs/man/nng_listener_get.3.adoc +++ b/docs/man/nng_listener_get.3.adoc @@ -43,9 +43,9 @@ int nng_listener_get_uint64(nng_listener l, const char *opt, uint64_t *u64p); (((options, listener))) The `nng_listener_get()` functions are used to retrieve option values for -the <> _l_. +the xref:nng_listener.5.adoc[listener] _l_. The actual options that may be retrieved in this way -vary, and many are documented in <>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -87,7 +87,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_listener_get_ms()`:: -This function is used to retrieve time <> +This function is used to retrieve time xref:nng_duration.5.adoc[durations] (such as timeouts), stored in _durp_ as a number of milliseconds. `nng_listener_get_ptr()`:: @@ -101,14 +101,14 @@ This function is used to retrieve a size into the pointer _zp_, typically for buffer sizes, message maximum sizes, and similar options. `nng_listener_get_addr()`:: -This function is used to retrieve an `<>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into the value referenced by _sap_. `nng_listener_get_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_listener_get_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -133,15 +133,15 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> -<> -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_listener_set.3.adoc[nng_listener_set(3)] +xref:nng_socket_get.3.adoc[nng_socket_get(3)], +xref:nng_strdup.3.adoc[nng_strdup(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_strfree.3.adoc[nng_strfree(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_getopt.3.adoc b/docs/man/nng_listener_getopt.3.adoc index 17ef0e71f..e232da96b 100644 --- a/docs/man/nng_listener_getopt.3.adoc +++ b/docs/man/nng_listener_getopt.3.adoc @@ -45,9 +45,9 @@ NOTE: These functions are deprecated. Please see xref:nng_listener_get.3.adoc[n (((options, listener))) The `nng_listener_getopt()` functions are used to retrieve option values for -the <> _l_. +the xref:nng_listener.5.adoc[listener] _l_. The actual options that may be retrieved in this way -vary, and many are documented in <>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -89,7 +89,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_listener_getopt_ms()`:: -This function is used to retrieve time <> +This function is used to retrieve time xref:nng_duration.5.adoc[durations] (such as timeouts), stored in _durp_ as a number of milliseconds. `nng_listener_getopt_ptr()`:: @@ -103,14 +103,14 @@ This function is used to retrieve a size into the pointer _zp_, typically for buffer sizes, message maximum sizes, and similar options. `nng_listener_getopt_sockaddr()`:: -This function is used to retrieve an `<>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into the value referenced by _sap_. `nng_listener_getopt_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_listener_getopt_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -135,15 +135,15 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> -<> -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)] +xref:nng_getopt.3.adoc[nng_getopt(3)], +xref:nng_strdup.3.adoc[nng_strdup(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_strfree.3.adoc[nng_strfree(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_id.3.adoc b/docs/man/nng_listener_id.3.adoc index 665911355..974a7f01c 100644 --- a/docs/man/nng_listener_id.3.adoc +++ b/docs/man/nng_listener_id.3.adoc @@ -29,11 +29,11 @@ listener _l_, if it is valid. Otherwise it returns `-1`. NOTE: A listener is considered valid if it was ever created with the -`<>` or -`<>` functions. +xref:nng_listener_create.3.adoc[`nng_listener_create()`] or +xref:nng_listen.3.adoc[`nng_listen()`] functions. listeners that are allocated on the stack or statically should be initialized with the macro -`<>` to ensure that +xref:nng_ctx.5.adoc#NNG_LISTENER_INITIALIZER[`NNG_LISTENER_INITIALIZER`] to ensure that they cannot be confused with a valid listener before they are created properly. == RETURN VALUES @@ -48,5 +48,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_set.3.adoc b/docs/man/nng_listener_set.3.adoc index e8caf56b4..89e3ca204 100644 --- a/docs/man/nng_listener_set.3.adoc +++ b/docs/man/nng_listener_set.3.adoc @@ -42,9 +42,9 @@ int nng_listener_set_uint64(nng_listener l, const char *opt, uint64_t u64); (((options, listener))) The `nng_listener_set()` functions are used to configure options for -the <> _l_. +the xref:nng_listener.5.adoc[listener] _l_. The actual options that may be configured in this way -vary, and many are documented in <>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -76,14 +76,14 @@ The _ival_ is passed to the option. `nng_listener_set_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_listener_set_ptr()`:: This function is used to pass a pointer, _ptr_, to structured data. The data referenced by _ptr_ is generally managed by other functions. For example, TLS configuration objects created with -(`<>`) +(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`]) can be passed this way. NOTE: This form is somewhat special in that the object is generally @@ -122,12 +122,12 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> -<> -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_listener_get.3.adoc[nng_listener_get(3)] +xref:nng_socket_set.3.adoc[nng_socket_set(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_setopt.3.adoc b/docs/man/nng_listener_setopt.3.adoc index ad5139218..595b8a190 100644 --- a/docs/man/nng_listener_setopt.3.adoc +++ b/docs/man/nng_listener_setopt.3.adoc @@ -44,9 +44,9 @@ NOTE: These functions are deprecated. Please see xref:nng_listener_set.3.adoc[n (((options, listener))) The `nng_listener_setopt()` functions are used to configure options for -the <> _l_. +the xref:nng_listener.5.adoc[listener] _l_. The actual options that may be configured in this way -vary, and many are documented in <>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -78,14 +78,14 @@ The _ival_ is passed to the option. `nng_listener_setopt_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_listener_setopt_ptr()`:: This function is used to pass a pointer, _ptr_, to structured data. The data referenced by _ptr_ is generally managed by other functions. For example, TLS configuration objects created with -(`<>`) +(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`]) can be passed this way. NOTE: This form is somewhat special in that the object is generally @@ -124,12 +124,12 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> -<> -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)] +xref:nng_setopt.3.adoc[nng_setopt(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_listener_start.3.adoc b/docs/man/nng_listener_start.3.adoc index 4703c9cad..b8f59ed92 100644 --- a/docs/man/nng_listener_start.3.adoc +++ b/docs/man/nng_listener_start.3.adoc @@ -29,7 +29,7 @@ The `nng_listener_start()` function starts the listener _l_. This causes the listener to bind to the address it was created with, and to start accepting connections from remote dialers. -Each new connection results in an `<>` object, +Each new connection results in an xref:nng_pipe.5.adoc[`nng_pipe`] object, which will be attached to the listener's socket. The _flags_ argument is ignored, but reserved for future use. @@ -50,8 +50,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> -<>, -<>, -<> +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg.5.adoc b/docs/man/nng_msg.5.adoc index b4c776c3f..61332fd74 100644 --- a/docs/man/nng_msg.5.adoc +++ b/docs/man/nng_msg.5.adoc @@ -30,12 +30,12 @@ Messages internally have a ((body)), containing the application supplied payload, and a ((header)), containing protocol specific routing and similar related information. -TIP: Using the message-oriented functions in the <> API is +TIP: Using the message-oriented functions in the xref:nng.7.adoc[_nng_] API is a good way to reduce the likelihood of data copies and improve application performance. -Messages are allocated using the <> -function, and are deallocated using the <> +Messages are allocated using the xref:nng_msg_alloc.3.adoc[`nng_msg_alloc()`] +function, and are deallocated using the xref:nng_msg_free.3.adoc[`nng_msg_free()`] function. In addition there are other functions used to access message contents, @@ -47,17 +47,17 @@ by making use of scratch areas at the beginning and end of the message. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_dup.3.adoc[nng_msg_dup(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_recvmsg.3.adoc[nng_recvmsg(3)], +xref:nng_sendmsg.3.adoc[nng_sendmsg(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_alloc.3.adoc b/docs/man/nng_msg_alloc.3.adoc index e164c577e..a1dc1c2e6 100644 --- a/docs/man/nng_msg_alloc.3.adoc +++ b/docs/man/nng_msg_alloc.3.adoc @@ -41,13 +41,13 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_dup.3.adoc[nng_msg_dup(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_append.3.adoc b/docs/man/nng_msg_append.3.adoc index fc87e15d1..9ed3741d4 100644 --- a/docs/man/nng_msg_append.3.adoc +++ b/docs/man/nng_msg_append.3.adoc @@ -45,14 +45,14 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_chop.3.adoc[nng_msg_chop(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_insert.3.adoc[nng_msg_insert(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_msg_trim.3.adoc[nng_msg_trim(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_body.3.adoc b/docs/man/nng_msg_body.3.adoc index af24e976f..e36e4bfdd 100644 --- a/docs/man/nng_msg_body.3.adoc +++ b/docs/man/nng_msg_body.3.adoc @@ -30,12 +30,12 @@ content of the message _msg_. NOTE: The value returned by this is invalidated by a call to any of the functions that modify the message itself. Such functions are -`<>`, -`<>`, -any of the `<>`, -`<>`, -`<>`, -or `<>` variants. +xref:nng_msg_free.3.adoc[`nng_msg_free()`], +xref:nng_msg_realloc.3.adoc[`nng_msg_realloc()`], +any of the xref:nng_msg_trim.3.adoc[`nng_msg_trim()`], +xref:nng_msg_chop.3.adoc[`nng_msg_chop()`], +xref:nng_msg_append.3.adoc[`nng_msg_append()`], +or xref:nng_msg_insert.3.adoc[`nng_msg_insert()`] variants. == RETURN VALUES @@ -48,13 +48,13 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_append.3.adoc[nng_msg_append(3)], +xref:nng_msg_chop.3.adoc[nng_msg_chop(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_insert.3.adoc[nng_msg_insert(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_msg_trim.3.adoc[nng_msg_trim(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_chop.3.adoc b/docs/man/nng_msg_chop.3.adoc index 1ecde4358..435d9776c 100644 --- a/docs/man/nng_msg_chop.3.adoc +++ b/docs/man/nng_msg_chop.3.adoc @@ -46,14 +46,14 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_append.3.adoc[nng_msg_append(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_insert.3.adoc[nng_msg_insert(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_msg_trim.3.adoc[nng_msg_trim(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_clear.3.adoc b/docs/man/nng_msg_clear.3.adoc index b2f841b19..e5b3bf472 100644 --- a/docs/man/nng_msg_clear.3.adoc +++ b/docs/man/nng_msg_clear.3.adoc @@ -37,5 +37,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_dup.3.adoc b/docs/man/nng_msg_dup.3.adoc index 22ca4875f..b985d5bbf 100644 --- a/docs/man/nng_msg_dup.3.adoc +++ b/docs/man/nng_msg_dup.3.adoc @@ -42,8 +42,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_free.3.adoc b/docs/man/nng_msg_free.3.adoc index 4d1109012..1ee045c04 100644 --- a/docs/man/nng_msg_free.3.adoc +++ b/docs/man/nng_msg_free.3.adoc @@ -37,7 +37,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_get_pipe.3.adoc b/docs/man/nng_msg_get_pipe.3.adoc index 2f9a9c84b..154f4c433 100644 --- a/docs/man/nng_msg_get_pipe.3.adoc +++ b/docs/man/nng_msg_get_pipe.3.adoc @@ -24,7 +24,7 @@ nng_pipe nng_msg_get_pipe(nng_msg *msg); == DESCRIPTION -The `nng_msg_get_pipe()` returns the `<>` object +The `nng_msg_get_pipe()` returns the xref:nng_pipe.5.adoc[`nng_pipe`] object associated with message _msg_. On receive, this is the pipe from which a message was received. On transmit, this would be the pipe that the message should be delivered @@ -36,7 +36,7 @@ The most usual use case for this is to obtain information about the peer from which the message was received. This can be used to provide different behaviors for different peers, such as a higher level of authentication for peers located on an untrusted network. -The `<>` function +The xref:nng_pipe_getopt.3.adoc[`nng_pipe_getopt()`] function is useful in this situation. @@ -54,7 +54,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_set_pipe.3.adoc[nng_msg_set_pipe(3)], +xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header.3.adoc b/docs/man/nng_msg_header.3.adoc index 80b402ef7..eac45ffdd 100644 --- a/docs/man/nng_msg_header.3.adoc +++ b/docs/man/nng_msg_header.3.adoc @@ -30,7 +30,7 @@ content of the message _msg_. NOTE: The message header contains protocol-specific header content. Most applications should not need to access this content, but it is available for raw mode sockets (set with the -`<>` option.) +xref:nng_options.5.adoc#NNG_OPT_RAW[`NNG_OPT_RAW`] option.) NOTE: The value returned by this is invalidated by a call to any of the functions that modify the message or the header content. @@ -46,13 +46,13 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_header_append.3.adoc[nng_msg_header_append(3)], +xref:nng_msg_header_chop.3.adoc[nng_msg_header_chop(3)], +xref:nng_msg_header_insert.3.adoc[nng_msg_header_insert(3)] +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_header_trim.3.adoc[nng_msg_header_trim(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header_append.3.adoc b/docs/man/nng_msg_header_append.3.adoc index 08e48b741..16badf0b9 100644 --- a/docs/man/nng_msg_header_append.3.adoc +++ b/docs/man/nng_msg_header_append.3.adoc @@ -47,12 +47,12 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg_header_chop.3.adoc[nng_msg_header_chop(3)], +xref:nng_msg_header_insert.3.adoc[nng_msg_header_insert(3)], +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_header_trim.3.adoc[nng_msg_header_trim(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header_chop.3.adoc b/docs/man/nng_msg_header_chop.3.adoc index c9c9113b1..454e9e517 100644 --- a/docs/man/nng_msg_header_chop.3.adoc +++ b/docs/man/nng_msg_header_chop.3.adoc @@ -47,12 +47,12 @@ These function return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg_header_append.3.adoc[nng_msg_header_append(3)], +xref:nng_msg_header_insert.3.adoc[nng_msg_header_insert(3)], +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_header_trim.3.adoc[nng_msg_header_trim(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header_clear.3.adoc b/docs/man/nng_msg_header_clear.3.adoc index 430dc4d41..d00286ed3 100644 --- a/docs/man/nng_msg_header_clear.3.adoc +++ b/docs/man/nng_msg_header_clear.3.adoc @@ -37,6 +37,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header_insert.3.adoc b/docs/man/nng_msg_header_insert.3.adoc index 1b1437f7c..1f3f6c2e4 100644 --- a/docs/man/nng_msg_header_insert.3.adoc +++ b/docs/man/nng_msg_header_insert.3.adoc @@ -46,13 +46,13 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg_header_append.3.adoc[nng_msg_header_append(3)], +xref:nng_msg_header_chop.3.adoc[nng_msg_header_chop(3)], +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_header_trim.3.adoc[nng_msg_header_trim(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header_len.3.adoc b/docs/man/nng_msg_header_len.3.adoc index c6b6a170c..0a7b3613a 100644 --- a/docs/man/nng_msg_header_len.3.adoc +++ b/docs/man/nng_msg_header_len.3.adoc @@ -37,7 +37,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_header_trim.3.adoc b/docs/man/nng_msg_header_trim.3.adoc index 0a9caea3e..6df504ffd 100644 --- a/docs/man/nng_msg_header_trim.3.adoc +++ b/docs/man/nng_msg_header_trim.3.adoc @@ -47,13 +47,13 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_header.3.adoc[nng_msg_header(3)], +xref:nng_msg_header_append.3.adoc[nng_msg_header_append(3)], +xref:nng_msg_header_chop.3.adoc[nng_msg_header_chop(3)], +xref:nng_msg_header_insert.3.adoc[nng_msg_header_insert(3)], +xref:nng_msg_header_len.3.adoc[nng_msg_header_len(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_insert.3.adoc b/docs/man/nng_msg_insert.3.adoc index cc910531a..ff69b8a44 100644 --- a/docs/man/nng_msg_insert.3.adoc +++ b/docs/man/nng_msg_insert.3.adoc @@ -50,14 +50,14 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_append.3.adoc[nng_msg_append(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_chop.3.adoc[nng_msg_chop(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_msg_trim.3.adoc[nng_msg_trim(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_len.3.adoc b/docs/man/nng_msg_len.3.adoc index 41f1cc644..2a3dfe67e 100644 --- a/docs/man/nng_msg_len.3.adoc +++ b/docs/man/nng_msg_len.3.adoc @@ -37,7 +37,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_realloc.3.adoc b/docs/man/nng_msg_realloc.3.adoc index 03a2494d4..4d57921be 100644 --- a/docs/man/nng_msg_realloc.3.adoc +++ b/docs/man/nng_msg_realloc.3.adoc @@ -31,11 +31,11 @@ and will reuse the existing memory when possible. TIP: One way to further reduce message allocations is to allocate a message larger than needed, then use this function or -`<>` to reduce the message size +xref:nng_msg_chop.3.adoc[`nng_msg_chop()`] to reduce the message size to that actually needed. The extra space left over will still be present in the message, so that when the message size -needs to grow due to this function or `<>` +needs to grow due to this function or xref:nng_msg_append.3.adoc[`nng_msg_append()`] no actual memory allocations need to take place. NOTE: Pointers to message body and header content obtained prior to this @@ -54,14 +54,14 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_append.3.adoc[nng_msg_append(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_chop.3.adoc[nng_msg_chop(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_insert.3.adoc[nng_msg_insert(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_trim.3.adoc[nng_msg_trim(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_set_pipe.3.adoc b/docs/man/nng_msg_set_pipe.3.adoc index d13c0dd77..c95cc83f3 100644 --- a/docs/man/nng_msg_set_pipe.3.adoc +++ b/docs/man/nng_msg_set_pipe.3.adoc @@ -27,8 +27,8 @@ void nng_msg_set_pipe(nng_msg *msg, nng_pipe p); The `nng_msg_set_pipe()` sets the pipe associated with message _m_ to _p_. This is most often useful when used with protocols that support directing a message to a specific peer. -For example the <> version -1 protocol can do this when `NNG_OPT_PAIR1_POLY` mode is set. +For example the xref:nng_pair.7.adoc[_pair_] version 1 protocol can do +this when `NNG_OPT_PAIR1_POLY` mode is set. NOTE: Not all protocols support overriding the destination pipe. @@ -43,9 +43,8 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> - +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe(3)], +xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_msg_trim.3.adoc b/docs/man/nng_msg_trim.3.adoc index 644b6f443..aa482958e 100644 --- a/docs/man/nng_msg_trim.3.adoc +++ b/docs/man/nng_msg_trim.3.adoc @@ -47,14 +47,14 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_msg_append.3.adoc[nng_msg_append(3)], +xref:nng_msg_body.3.adoc[nng_msg_body(3)], +xref:nng_msg_chop.3.adoc[nng_msg_chop(3)], +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_msg_insert.3.adoc[nng_msg_insert(3)], +xref:nng_msg_len.3.adoc[nng_msg_len(3)], +xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_mtx_alloc.3supp.adoc b/docs/man/nng_mtx_alloc.3supp.adoc index 3a327338c..696c3e567 100644 --- a/docs/man/nng_mtx_alloc.3supp.adoc +++ b/docs/man/nng_mtx_alloc.3supp.adoc @@ -50,9 +50,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_mtx_free.3supp.adoc[nng_mtx_free(3supp)], +xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock(3supp)], +xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock(3supp)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_mtx_free.3supp.adoc b/docs/man/nng_mtx_free.3supp.adoc index e30e861fd..2867afe16 100644 --- a/docs/man/nng_mtx_free.3supp.adoc +++ b/docs/man/nng_mtx_free.3supp.adoc @@ -39,5 +39,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_mtx_lock.3supp.adoc b/docs/man/nng_mtx_lock.3supp.adoc index 6a0c50069..33504da15 100644 --- a/docs/man/nng_mtx_lock.3supp.adoc +++ b/docs/man/nng_mtx_lock.3supp.adoc @@ -27,7 +27,7 @@ void nng_mtx_lock(nng_mtx *mtx); The `nng_mtx_lock()` acquires exclusive ownership of the mutex _mtx_. If the lock is already owned, this function will wait until the current -owner releases it with `<>`. +owner releases it with xref:nng_mtx_unlock.3supp.adoc[`nng_mtx_unlock()`]. If multiple threads are waiting for the lock, the order of acquisition is not specified. @@ -58,7 +58,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_mtx_unlock.3supp.adoc b/docs/man/nng_mtx_unlock.3supp.adoc index 7d855b7b4..d1b048e6d 100644 --- a/docs/man/nng_mtx_unlock.3supp.adoc +++ b/docs/man/nng_mtx_unlock.3supp.adoc @@ -26,7 +26,7 @@ void nng_mtx_unlock(nng_mtx *mtx); == DESCRIPTION The `nng_mtx_unlock()` relinquishes ownership of the mutex _mtx_ that -was previously acquired via `<>`. +was previously acquired via xref:nng_mtx_lock.3supp.adoc[`nng_mtx_lock()`]. IMPORTANT: A mutex can _only_ be unlocked by the thread that locked it. Attempting to unlock a mutex that is not owned by the caller will result @@ -43,6 +43,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_options.5.adoc b/docs/man/nng_options.5.adoc index d076efa96..449eea4d8 100644 --- a/docs/man/nng_options.5.adoc +++ b/docs/man/nng_options.5.adoc @@ -107,7 +107,7 @@ to them; instead the application is expected to perform such semantics itself. (For example, in "`cooked`" mode a xref:nng_rep.7.adoc[_rep_] socket would automatically copy message headers from a received message to the corresponding reply, whereas in "`raw`" mode this is not done.) -See xref:nng.7#raw_mode[Raw Mode] for more details. +See xref:nng.7.adoc#raw_mode[Raw Mode] for more details. [[NNG_OPT_RECONNMINT]] ((`NNG_OPT_RECONNMINT`)):: diff --git a/docs/man/nng_opts_parse.3supp.adoc b/docs/man/nng_opts_parse.3supp.adoc index 2fbbe443e..beb9e1bf5 100644 --- a/docs/man/nng_opts_parse.3supp.adoc +++ b/docs/man/nng_opts_parse.3supp.adoc @@ -181,5 +181,5 @@ no more options are available to be parsed, or an error number otherwise. == SEE ALSO [.text-left] -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pair.7.adoc b/docs/man/nng_pair.7.adoc index 4fefeb61a..aeb20407c 100644 --- a/docs/man/nng_pair.7.adoc +++ b/docs/man/nng_pair.7.adoc @@ -39,18 +39,18 @@ Using this mode requires some additional sophistication in the application. === Socket Operations -The `<>` functions create _pair_ socket. +The xref:nng_pair_open.3.adoc[`nng_pair_open()`] functions create a _pair_ socket. Normally, this pattern will block when attempting to send a message if no peer is able to receive the message. NOTE: Even though this mode may appear to be "reliable", because back-pressure prevents discarding messages most of the time, there are topologies involving -_devices_ (see `<>`) or raw mode sockets -(see `<>`) where +_devices_ (see xref:nng_device.3.adoc[`nng_device()`]) or raw mode sockets +(see xref:nng_options.5.adoc#NNG_OPT_RAW[`NNG_OPT_RAW`]) where messages may be discarded. Applications that require reliable delivery semantics should consider using -<> sockets, or +xref:nng_req.7.adoc[_req_] sockets, or implement their own acknowledgment layer on top of _pair_ sockets. In order to avoid head-of-line blocking conditions, _polyamorous_ mode _pair_ @@ -68,7 +68,7 @@ including the legacy https://github.com/nanomsg/nanomsg[nanomsg] library or https://github.com/go-mangos/mangos[mangos]. Version 1 of the protocol offers improved protection against loops when -used with `<>`. +used with xref:nng_device.3.adoc[`nng_device()`]. It also offers _polyamorous_ mode for forming multiple partnerships on a single socket. @@ -84,11 +84,11 @@ In ((_polyamorous_ mode)), which is only available with version 1, a socket can support many one-to-one connections. In this mode, the application must choose the remote peer to receive an outgoing message by setting the -`<>` to use for the outgoing message with -the `<>` function. +xref:nng_pipe.5.adoc[`nng_pipe`] to use for the outgoing message with +the xref:nng_msg_set_pipe.3.adoc[`nng_msg_set_pipe()`] function. Most often the value of the outgoing pipe will be obtained from an incoming -message using the `<>` function, +message using the xref:nng_msg_get_pipe.3.adoc[`nng_msg_get_pipe()`] function, such as when replying to an incoming message. In order to prevent head-of-line blocking, if the peer on the given pipe @@ -106,7 +106,7 @@ The following protocol-specific options are available. The value is read-write, and takes an integer Boolean value. The default false value (0) indicates that legacy monogamous mode should be used. -`<>`:: +xref:nng_options.5.adoc#NNG_OPT_MAXTTL[`NNG_OPT_MAXTTL`]:: (`int`, version 1 only). Maximum time-to-live. @@ -117,7 +117,7 @@ Version 0 of the pair protocol has no protocol-specific headers. Version 1 of the pair protocol uses a single 32-bit unsigned value. The low-order (big-endian) byte of this value contains a "hop" count, and is used in conjunction with the -`<>` option to guard against +xref:nng_options.5.adoc#NNG_OPT_MAXTTL[`NNG_OPT_MAXTTL`] option to guard against device forwarding loops. This value is initialized to 1, and incremented each time the message is received by a new node. @@ -125,6 +125,6 @@ received by a new node. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_pair_open.3.adoc[nng_pair_open(3)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pair_open.3.adoc b/docs/man/nng_pair_open.3.adoc index dd52fca9a..c61e61100 100644 --- a/docs/man/nng_pair_open.3.adoc +++ b/docs/man/nng_pair_open.3.adoc @@ -38,13 +38,13 @@ int nng_pair1_open_raw(nng_socket *s); == DESCRIPTION The `nng_pair0_open()` and `nng_pair1_open()` functions -create a <> version 0 or version 1 -<> and return it at the location pointed to by _s_. +create a xref:nng_pair.7.adoc[_pair_] version 0 or version 1 +xref:nng_socket.5.adoc[socket] and return it at the location pointed to by _s_. The `nng_pair0_open_raw()` and `nng_pair1_open_raw()` functions -create a <> version 0 or version 1 -<> in -<> mode and return it at the location pointed to by _s_. +create a xref:nng_pair.7.adoc[_pair_] version 0 or version 1 +xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and return it at the location pointed to by _s_. == RETURN VALUES @@ -59,6 +59,6 @@ These functions returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_pair.7.adoc[nng_pair(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe.5.adoc b/docs/man/nng_pipe.5.adoc index 39807a84b..8f9442c64 100644 --- a/docs/man/nng_pipe.5.adoc +++ b/docs/man/nng_pipe.5.adoc @@ -42,12 +42,12 @@ 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. -Pipe objects are created by dialers (`<>` objects) -and listeners (`<>` objects), which can be +Pipe objects are created by dialers (xref:nng_dialer.5.adoc[`nng_dialer`] objects) +and listeners (xref:nng_listener.5.adoc[`nng_listener`] objects), which can be thought of as "`owning`" the pipe. Pipe objects may be destroyed by the -`<>` function. +xref:nng_pipe_close.3.adoc[`nng_pipe_close()`] function. They are also closed when their "`owning`" dialer or listener is closed, or when the remote peer closes the underlying connection. @@ -67,14 +67,14 @@ nng_pipe p = NNG_PIPE_INITIALIZER; == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe(3)], +xref:nng_pipe_close.3.adoc[nng_pipe_close(3)], +xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt(3)], +xref:nng_pipe_dialer.3.adoc[nng_pipe_dialer(3)], +xref:nng_pipe_id.3.adoc[nng_pipe_id(3)], +xref:nng_pipe_listener.3.adoc[nng_pipe_listener(3)], +xref:nng_pipe_socket.3.adoc[nng_pipe_socket(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_close.3.adoc b/docs/man/nng_pipe_close.3.adoc index 7dd12e7ee..a8de660fc 100644 --- a/docs/man/nng_pipe_close.3.adoc +++ b/docs/man/nng_pipe_close.3.adoc @@ -46,7 +46,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_dialer.3.adoc b/docs/man/nng_pipe_dialer.3.adoc index ede04a4da..c2a68c5e0 100644 --- a/docs/man/nng_pipe_dialer.3.adoc +++ b/docs/man/nng_pipe_dialer.3.adoc @@ -24,10 +24,10 @@ nng_dialer nng_pipe_dialer(nng_pipe p); == DESCRIPTION -The `nng_pipe_dialer()` function returns the `<>` +The `nng_pipe_dialer()` function returns the xref:nng_dialer.5.adoc[`nng_dialer`] that created the pipe _p_. If the pipe was not created by a dialer, then the returned value will -have an identifier (`<>`) of `-1`. +have an identifier (xref:nng_dialer_id.3.adoc[`nng_dialer_id()`]) of `-1`. == RETURN VALUES @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_get.3.adoc b/docs/man/nng_pipe_get.3.adoc index 791827b92..cc7a7efb4 100644 --- a/docs/man/nng_pipe_get.3.adoc +++ b/docs/man/nng_pipe_get.3.adoc @@ -43,16 +43,16 @@ int nng_pipe_get_uint64(nng_pipe p, const char *opt, uint64_t *u64p); (((options, pipe))) The `nng_pipe_get()` functions are used to retrieve option values for -the <> _p_. +the xref:nng_pipe.5.adoc[pipe] _p_. The actual options that may be retrieved in this way -vary, and many are documented in <>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. NOTE: All "`options`" on a pipe are read-only values. Modification of options may be done before the pipe is created using -`<>` or -`<>`. +xref:nng_listener_set.3.adoc[`nng_listener_set()`] or +xref:nng_dialer_get.3.adoc[`nng_dialer_set()`]. Any option that is set on a dialer or listener will normally be retrievable from pipes created by that dialer or listener. @@ -93,7 +93,7 @@ The value will be stored at _ivalp_. `nng_pipe_get_ms()`:: This function is used to retrieve time durations -(`<>`) in milliseconds, which are stored in +(xref:nng_duration.5.adoc[`nng_duration`]) in milliseconds, which are stored in _durp_. `nng_pipe_get_ptr()`:: @@ -107,14 +107,14 @@ This function is used to retrieve a size into the pointer _zp_, typically for buffer sizes, message maximum sizes, and similar options. `nng_pipe_get_addr()`:: -This function is used to retrieve an `<>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into _sap_. `nng_pipe_get_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_pipe_get_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -139,15 +139,15 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<> -<>, -<> -<> -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_dialer_set.3.adoc[nng_dialer_set(3)] +xref:nng_socket_get.3.adoc[nng_socket_get(3)], +xref:nng_listener_set.3.adoc[nng_listener_set(3)] +xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe(3)] +xref:nng_strdup.3.adoc[nng_strdup(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_strfree.3.adoc[nng_strfree(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_getopt.3.adoc b/docs/man/nng_pipe_getopt.3.adoc index 111aa493a..c1b7dca6a 100644 --- a/docs/man/nng_pipe_getopt.3.adoc +++ b/docs/man/nng_pipe_getopt.3.adoc @@ -45,16 +45,16 @@ NOTE: These functions are deprecated. Please see xref:nng_pipe_get.3.adoc[nng_p (((options, pipe))) The `nng_pipe_getopt()` functions are used to retrieve option values for -the <> _p_. +the xref:nng_pipe.5.adoc[pipe] _p_. The actual options that may be retrieved in this way -vary, and many are documented in <>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. NOTE: All "`options`" on a pipe are read-only values. Modification of options may be done before the pipe is created using -`<>` or -`<>`. +xref:nng_listener_setopt.3.adoc[`nng_listener_setopt()`] or +xref:nng_dialer_getopt.3.adoc[`nng_dialer_setopt()`]. Any option that is set on a dialer or listener will normally be retrievable from pipes created by that dialer or listener. @@ -95,7 +95,7 @@ The value will be stored at _ivalp_. `nng_pipe_getopt_ms()`:: This function is used to retrieve time durations -(`<>`) in milliseconds, which are stored in +(xref:nng_duration.5.adoc[`nng_duration`]) in milliseconds, which are stored in _durp_. `nng_pipe_getopt_ptr()`:: @@ -109,14 +109,14 @@ This function is used to retrieve a size into the pointer _zp_, typically for buffer sizes, message maximum sizes, and similar options. `nng_pipe_getopt_sockaddr()`:: -This function is used to retrieve an `<>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into _sap_. `nng_pipe_getopt_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_pipe_getopt_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -141,15 +141,15 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<> -<>, -<> -<> -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)] +xref:nng_getopt.3.adoc[nng_getopt(3)], +xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)] +xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe(3)] +xref:nng_strdup.3.adoc[nng_strdup(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_strfree.3.adoc[nng_strfree(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_id.3.adoc b/docs/man/nng_pipe_id.3.adoc index 5cf821f00..9b8e8ee67 100644 --- a/docs/man/nng_pipe_id.3.adoc +++ b/docs/man/nng_pipe_id.3.adoc @@ -31,7 +31,7 @@ Otherwise it returns `-1`. NOTE: A pipe is considered valid if it was ever created by the socket. Pipes that are allocated on the stack or statically should be initialized with the macro -`<>` to ensure that +xref:nng_pipe.5.adoc#NNG_PIPE_INITIALIZER[`NNG_PIPE_INITIALIZER`] to ensure that they cannot be confused with a valid pipe. == RETURN VALUES @@ -46,5 +46,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_listener.3.adoc b/docs/man/nng_pipe_listener.3.adoc index 6742867de..78ae0500f 100644 --- a/docs/man/nng_pipe_listener.3.adoc +++ b/docs/man/nng_pipe_listener.3.adoc @@ -24,10 +24,10 @@ nng_listener nng_pipe_listener(nng_pipe p); == DESCRIPTION -The `nng_pipe_listener()` function returns the `<>` +The `nng_pipe_listener()` function returns the xref:nng_listener.5.adoc[`nng_listener`] that created the pipe _p_. If the pipe was not created by a listener, then the returned value will -have an identifier (`<>`) of `-1`. +have an identifier (xref:nng_listener_id.3.adoc[`nng_listener_id()`]) of `-1`. == RETURN VALUES @@ -42,6 +42,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_notify.3.adoc b/docs/man/nng_pipe_notify.3.adoc index d5d75400b..8bb9fcfd2 100644 --- a/docs/man/nng_pipe_notify.3.adoc +++ b/docs/man/nng_pipe_notify.3.adoc @@ -34,7 +34,7 @@ int nng_pipe_notify(nng_socket s, nng_pipe_ev ev, nng_pipe_cb cb, void *arg); == DESCRIPTION The `nng_pipe_notify()` function registers the callback function _cb_ -to be called whenever a <> the pipe event specified by +to be called whenever a xref:nng_pipe.5.adoc[pipe] the pipe event specified by _ev_ occurs on the socket _s_. The callback _cb_ will be passed _arg_ as its final argument. @@ -46,7 +46,7 @@ The following pipe events are supported: `NNG_PIPE_EV_ADD_PRE`:: This event occurs after a connection and negotiation has completed, but before the pipe is added to the socket. -If the pipe is closed (using `<>`) at +If the pipe is closed (using xref:nng_pipe_close.3.adoc[`nng_pipe_close()`]) at this point, the socket will never see the pipe, and no further events will occur for the given pipe. @@ -61,7 +61,7 @@ The underlying transport may be closed at this point, and it is not possible communicate using this pipe. TIP: The callback _cb_ may close a pipe for any reason by simply closing -it using `<>`. +it using xref:nng_pipe_close.3.adoc[`nng_pipe_close()`]. This might be done before the pipe is added to the socket (during `NNG_PIPE_EV_ADD_PRE`), for example, if the remote peer is not authorized. @@ -82,8 +82,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_pipe_close.3.adoc[nng_pipe_close(3)], +xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt(3)], +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pipe_socket.3.adoc b/docs/man/nng_pipe_socket.3.adoc index ec5237186..e5da1d550 100644 --- a/docs/man/nng_pipe_socket.3.adoc +++ b/docs/man/nng_pipe_socket.3.adoc @@ -24,7 +24,7 @@ nng_socket nng_pipe_socket(nng_pipe p); == DESCRIPTION -The `nng_pipe_socket()` function returns the `<>` +The `nng_pipe_socket()` function returns the xref:nng_socket.5.adoc[`nng_socket`] that owns the pipe _p_. NOTE: The returned socket may be closed or in the process of closing, in @@ -41,6 +41,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pub.7.adoc b/docs/man/nng_pub.7.adoc index 5a2745110..fcebd417a 100644 --- a/docs/man/nng_pub.7.adoc +++ b/docs/man/nng_pub.7.adoc @@ -30,7 +30,7 @@ The subscribing applications only see the data to which they have subscribed. The _pub_ protocol is the publisher side, and the -<> protocol is the subscriber side. +xref:nng_sub.7.adoc[_sub_] protocol is the subscriber side. NOTE: In this implementation, the publisher delivers all messages to all subscribers. @@ -44,7 +44,7 @@ Applications should construct their messages accordingly. === Socket Operations -The `<>` functions create a publisher socket. +The xref:nng_pub_open.3.adoc[`nng_pub0_open()`] functions create a publisher socket. This socket may be used to send messages, but is unable to receive them. Attempts to receive messages will result in `NNG_ENOTSUP`. @@ -64,6 +64,6 @@ The _pub_ protocol has no protocol-specific headers. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_pub_open.3.adoc[nng_pub_open(3)], +xref:nng_sub.7.adoc[nng_sub(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pub_open.3.adoc b/docs/man/nng_pub_open.3.adoc index 3aa02a5c2..c9f3b5b5e 100644 --- a/docs/man/nng_pub_open.3.adoc +++ b/docs/man/nng_pub_open.3.adoc @@ -27,12 +27,12 @@ int nng_pub0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_pub0_open()` function creates a <> version 0 -<> and returns it at the location pointed to by _s_. +The `nng_pub0_open()` function creates a xref:nng_pub.7.adoc[_pub_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_pub0_open_raw()` function creates a <> version 0 -<> in -<> mode and returns it at the location pointed to by _s_. +The `nng_pub0_open_raw()` function creates a xref:nng_pub.7.adoc[_pub_] version 0 +xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -47,7 +47,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_pub.7.adoc[nng_pub(7)], +xref:nng_sub.7.adoc[nng_sub(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pull.7.adoc b/docs/man/nng_pull.7.adoc index 558c39e89..0b325dab0 100644 --- a/docs/man/nng_pull.7.adoc +++ b/docs/man/nng_pull.7.adoc @@ -24,7 +24,7 @@ nng_pull - pull protocol (((protocol, _pull_))) The ((_pull_ protocol)) is one half of a ((pipeline pattern)). -The other half is the <> protocol. +The other half is the xref:nng_push.7.adoc[_push_] protocol. In the pipeline pattern, pushers distribute messages to pullers. Each message sent @@ -35,7 +35,7 @@ This property makes this pattern useful in ((load-balancing)) scenarios. === Socket Operations -The `<>` functions create a puller socket. +The xref:nng_pull_open.3.adoc[`nng_pull0_open()`] functions create a puller socket. This socket may be used to receive messages, but is unable to send them. Attempts to send messages will result in `NNG_ENOTSUP`. @@ -60,6 +60,6 @@ The _pull_ protocol has no protocol-specific headers. == SEE ALSO [.text-left] -<>, -<>, -<>, +xref:nng_pull_open.3.adoc[nng_pull_open(3)], +xref:nng_push.7.adoc[nng_push(7)], +xref:nng.7.adoc[nng(7)], diff --git a/docs/man/nng_pull_open.3.adoc b/docs/man/nng_pull_open.3.adoc index a365faa3c..12f85978b 100644 --- a/docs/man/nng_pull_open.3.adoc +++ b/docs/man/nng_pull_open.3.adoc @@ -27,12 +27,12 @@ int nng_pull0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_pull0_open()` function creates a <> version 0 -<> and returns it at the location pointed to by _s_. +The `nng_pull0_open()` function creates a xref:nng_pull.7.adoc[_pull_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_pull0_open_raw()` function creates a <> version 0 -<> in -<> mode and returns it at the location pointed to by _s_. +The `nng_pull0_open_raw()` function creates a xref:nng_pull.7.adoc[_pull_] version 0 +xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -47,7 +47,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_pull.7.adoc[nng_pull(7)], +xref:nng_push.7.adoc[nng_push(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_push.7.adoc b/docs/man/nng_push.7.adoc index f227cc2f8..18c485793 100644 --- a/docs/man/nng_push.7.adoc +++ b/docs/man/nng_push.7.adoc @@ -24,7 +24,7 @@ nng_push - push protocol (((protocol, _push_))) The ((_push_ protocol)) is one half of a ((pipeline pattern)). -The other side is the <> protocol. +The other side is the xref:nng_pull.7.adoc[_pull_] protocol. In the pipeline pattern, pushers distribute messages to pullers. Each message sent by a pusher will be sent to one of its peer pullers, @@ -34,7 +34,7 @@ This property makes this pattern useful in ((load-balancing)) scenarios. === Socket Operations -The `<>` call creates a pusher socket. +The xref:nng_push_open.3.adoc[`nng_push0_open()`] call creates a pusher socket. This socket may be used to send messages, but is unable to receive them. Attempts to receive messages will result in `NNG_ENOTSUP`. @@ -47,7 +47,7 @@ NOTE: Although the pipeline protocol honors flow control, and attempts to avoid dropping messages, no guarantee of delivery is made. Furthermore, as there is no capability for message acknowledgment, applications that need reliable delivery are encouraged to consider the -<> protocol instead. +xref:nng_req.7.adoc[_req_] protocol instead. === Protocol Versions @@ -65,7 +65,7 @@ The _push_ protocol has no protocol-specific headers. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_push_open.3.adoc[nng_push(3)], +xref:nng_pull.7.adoc[nng_pull(7)], +xref:nng_req.7.adoc[nng_req(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_push_open.3.adoc b/docs/man/nng_push_open.3.adoc index 43fef86f7..1b1635ef4 100644 --- a/docs/man/nng_push_open.3.adoc +++ b/docs/man/nng_push_open.3.adoc @@ -27,12 +27,12 @@ int nng_push0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_push0_open()` function creates a <> version 0 -<> and returns it at the location pointed to by _s_. +The `nng_push0_open()` function creates a xref:nng_push.7.adoc[_push_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_push0_open_raw()` function creates a <> version 0 -<> in -<> mode and returns it at the location pointed to by _s_. +The `nng_push0_open_raw()` function creates a xref:nng_push.7.adoc[_push_] version 0 +xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -47,7 +47,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_pull.7.adoc[nng_pull(7)], +xref:nng_push.7.adoc[nng_push(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_random.3supp.adoc b/docs/man/nng_random.3supp.adoc index 424ad32bb..3f8ac39ec 100644 --- a/docs/man/nng_random.3supp.adoc +++ b/docs/man/nng_random.3supp.adoc @@ -42,4 +42,4 @@ None. == SEE ALSO [.text-left] -<> +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_recv.3.adoc b/docs/man/nng_recv.3.adoc index a0776ed8c..b430fe9d8 100644 --- a/docs/man/nng_recv.3.adoc +++ b/docs/man/nng_recv.3.adoc @@ -39,12 +39,12 @@ The _flags_ is a bit mask that may contain any of the following values: of another pointer (of type `void *`), and the _sizep_ pointer must be set to a location to receive the size of the message body. The function will then allocate a message buffer - (as if by `<>`), fill it with + (as if by xref:nng_alloc.3.adoc[`nng_alloc()`]), fill it with the message body, and store it at the address referenced by _data_, and update the size referenced by _sizep_. The caller is responsible for disposing of the received buffer either by - the `<>` function or passing the message (also - with the `NNG_FLAG_ALLOC` flag) in a call to `<>`. + the xref:nng_free.3.adoc[`nng_free()`] function or passing the message (also + with the `NNG_FLAG_ALLOC` flag) in a call to xref:nng_send.3.adoc[`nng_send()`]. If the special flag `NNG_FLAG_ALLOC` (see above) is not specified, then the caller must set _data_ to a buffer to receive the message body content, @@ -54,11 +54,11 @@ updated with the actual message body length copied into _data_. NOTE: The semantics of what receiving a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a <> socket a message may only be received -after a request has been sent, and a <> socket +(For example, with a xref:nng_req.7.adoc[_req_] socket a message may only be received +after a request has been sent, and a xref:nng_sub.7.adoc[_sub_] socket may only receive messages corresponding to topics to which it has subscribed.) Furthermore, some protocols may not support receiving data at all, such as -<>. +xref:nng_pub.7.adoc[_pub_]. TIP: The `NNG_FLAG_ALLOC` flag can be used to reduce data copies, thereby increasing performance, particularly if the buffer is reused to send @@ -83,9 +83,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_alloc.3.adoc[nng_alloc(3)], +xref:nng_free.3.adoc[nng_free(3)], +xref:nng_recvmsg.3.adoc[nng_recvmsg(3)], +xref:nng_send.3.adoc[nng_send(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_recv_aio.3.adoc b/docs/man/nng_recv_aio.3.adoc index e10149ac6..4c9704898 100644 --- a/docs/man/nng_recv_aio.3.adoc +++ b/docs/man/nng_recv_aio.3.adoc @@ -24,14 +24,14 @@ void nng_recv_aio(nng_socket s, nng_aio *aio); == DESCRIPTION -The `nng_recv_aio()` receives a <> using the -<> _s_ asynchronously. +The `nng_recv_aio()` receives a xref:nng_msg.5.adoc[message] using the +xref:nng_socket.5.adoc[socket] _s_ asynchronously. When a message is successfully received by the socket, it is stored in the _aio_ by an internal call equivalent to -`<>`, then the completion +xref:nng_aio_set_msg.3.adoc[`nng_aio_set_msg()`], then the completion callback on the _aio_ is executed. -In this case, `<>` will +In this case, xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return zero. The callback function is responsible for retrieving the message and disposing of it appropriately. @@ -42,16 +42,16 @@ case can lead to memory leaks. If for some reason the asynchronous receive cannot be completed successfully (including by being canceled or timing out), then the callback will still be executed, -but `<>` will be non-zero. +but xref:nng_aio_result.3.adoc[`nng_aio_result()`] will be non-zero. NOTE: The semantics of what receiving a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a <> socket the data is broadcast, so that +(For example, with a xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -`<>` or a similar function.) +xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.) Furthermore, some protocols may not support receiving (such as -<>) or may require other conditions. -(For example, <> sockets cannot normally receive data, which +xref:nng_pub.7.adoc[_pub_]) or may require other conditions. +(For example, xref:nng_req.7.adoc[_req_] sockets cannot normally receive data, which are replies to requests, until they have first sent a request.) == RETURN VALUES @@ -71,11 +71,11 @@ None. (The operation completes asynchronously.) == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_recvmsg.3.adoc b/docs/man/nng_recvmsg.3.adoc index bdcb48944..6f1fcea92 100644 --- a/docs/man/nng_recvmsg.3.adoc +++ b/docs/man/nng_recvmsg.3.adoc @@ -28,7 +28,7 @@ The `nng_recvmsg()` receives a message on socket _s_, storing the received message at the location pointed to by _msgp_. TIP: Using this function gives access to the message structure, and thus may -offer more functionality than the simpler `<>` function. +offer more functionality than the simpler xref:nng_recv.3.adoc[`nng_recv()`] function. The _flags_ may contain the following value: @@ -39,11 +39,11 @@ The _flags_ may contain the following value: NOTE: The semantics of what receiving a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with an <> socket a message may only be received -after a request has been sent, and an <> socket +(For example, with an xref:nng_req.7.adoc[_req_] socket a message may only be received +after a request has been sent, and an xref:nng_sub.7.adoc[_sub_] socket may only receive messages corresponding to topics to which it has subscribed.) Furthermore, some protocols may not support receiving data at all, such as -<>. +xref:nng_pub.7.adoc[_pub_]. == RETURN VALUES @@ -63,8 +63,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_msg_free.3.adoc[nng_msg_free(3)], +xref:nng_recv.3.adoc[nng_recv(3)], +xref:nng_sendmsg.3.adoc[nng_sendmsg(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_rep.7.adoc b/docs/man/nng_rep.7.adoc index f822849fc..07cd8dfdf 100644 --- a/docs/man/nng_rep.7.adoc +++ b/docs/man/nng_rep.7.adoc @@ -34,11 +34,11 @@ It is also "`reliable`", in that a the requester will keep retrying until a reply is received. The _rep_ protocol is the replier side, and the -<> protocol is the requester side. +xref:nng_req.7.adoc[_req_] protocol is the requester side. === Socket Operations -The `<>` functions create a replier socket. +The xref:nng_rep_open.3.adoc[`nng_rep0_open()`] functions create a replier socket. This socket may be used to receive messages (requests), and then to send replies. @@ -50,12 +50,12 @@ was previously received. Likewise, only one receive operation may be pending at a time. Any additional concurrent receive operations will result in `NNG_ESTATE`. -<> mode sockets ignore all these restrictions. +xref:nng.7.adoc#raw_mode[Raw] mode sockets ignore all these restrictions. === Context Operations -This protocol supports the creation of <> for concurrent -use cases using `<>`. +This protocol supports the creation of xref:nng_ctx.5.adoc[contexts] for concurrent +use cases using xref:nng_ctx_open.3.adoc[`nng_ctx_open()`]. Each context may have at most one outstanding request, and operates independently from the others. @@ -76,11 +76,11 @@ 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 <> manual. +This is more fully documented in the xref:nng_req.7.adoc[_req_] manual. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_rep_open.3.adoc[nng_rep_open(3)], +xref:nng.7.adoc[nng(7)], +xref:nng_req.7.adoc[nng_req(7)] diff --git a/docs/man/nng_rep_open.3.adoc b/docs/man/nng_rep_open.3.adoc index 29f6935a8..dd62201dc 100644 --- a/docs/man/nng_rep_open.3.adoc +++ b/docs/man/nng_rep_open.3.adoc @@ -27,12 +27,12 @@ int nng_rep0_open_raw(nng_socket *); == DESCRIPTION -The `nng_rep0_open()` function creates a <> version 0 -<> and returns it at the location pointed to by _s_. +The `nng_rep0_open()` function creates a xref:nng_rep.7.adoc[_rep_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_rep0_open_raw()` function creates a <> version 0 -<> -in <> mode and returns it at the location pointed to by _s_. +The `nng_rep0_open_raw()` function creates a xref:nng_rep.7.adoc[_rep_] version 0 +xref:nng_socket.5.adoc[socket] +in xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -47,7 +47,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_rep.7.adoc[nng_rep(7)], +xref:nng_req.7.adoc[nng_req(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_req.7.adoc b/docs/man/nng_req.7.adoc index 1ad2d3f49..ada83c65d 100644 --- a/docs/man/nng_req.7.adoc +++ b/docs/man/nng_req.7.adoc @@ -40,19 +40,19 @@ some reason.) (((load-balancing))) The requester generally only has one outstanding request at a time unless -in "raw" mode (via -`<>`), +in "`raw`" mode (via +xref:nng_options.5.adoc#NNG_OPT_RAW[`NNG_OPT_RAW`]), and it will generally attempt to spread work requests to different peer repliers. -TIP: This property, when combined with `<>` +TIP: This property, when combined with xref:nng_device.3.adoc[`nng_device()`] can help provide a degree of load-balancing. The _req_ protocol is the requester side, and the -<> protocol is the replier side. +xref:nng_rep.7.adoc[_rep_] protocol is the replier side. === Socket Operations -The `<>` functions create a requester socket. +The xref:nng_req_open.3.adoc[`nng_req0_open()`] functions create a requester socket. This socket may be used to send messages (requests), and then to receive replies. Generally a reply can only be received after sending a request. @@ -69,12 +69,12 @@ but it will not stop a replier from processing a request it has already received or terminate a request that has already been placed on the wire. -<> mode sockets ignore all these restrictions. +xref:nng.7.adoc#raw_mode[Raw] mode sockets ignore all these restrictions. === Context Operations -This protocol supports the creation of <> for concurrent -use cases using `<>`. +This protocol supports the creation of xref:nng_ctx.5.adoc[contexts] for concurrent +use cases using xref:nng_ctx_open.3.adoc[`nng_ctx_open()`]. The `NNG_OPT_REQ_RESENDTIME` value may be configured differently on contexts created this way. @@ -97,7 +97,7 @@ The following protocol-specific option is available. ((`NNG_OPT_REQ_RESENDTIME`)):: - (`<>`) + (xref:nng_duration.5.adoc[`nng_duration`]) When a new request is started, a timer of this duration is also started. If no reply is received before this timer expires, then the request will be resent. @@ -118,7 +118,7 @@ These will be distinguishable from the request ID by having their most significant bit clear. When a request message is received by a forwarding node (see -`<>`), the forwarding node prepends a +xref:nng_device.3.adoc[`nng_device()`]), the forwarding node prepends a 32-bit peer ID (which *must* have the most significant bit clear), which is the forwarder's way of identifying the directly connected peer from which it received the message. @@ -146,9 +146,9 @@ request ID it originally used for the request. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_ctx_open.3.adoc[nng_ctx_open(3)], +xref:nng_device.3.adoc[nng_device(3)], +xref:nng_req_open.3.adoc[nng_req_open(3)], +xref:nng_ctx.5.adoc[nng_ctx(5)], +xref:nng.7.adoc[nng(7)], +xref:nng_rep.7.adoc[nng_rep(7)] diff --git a/docs/man/nng_req_open.3.adoc b/docs/man/nng_req_open.3.adoc index bd948576e..0fd07944d 100644 --- a/docs/man/nng_req_open.3.adoc +++ b/docs/man/nng_req_open.3.adoc @@ -27,12 +27,12 @@ int nng_req0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_req0_open()` function creates a <> version 0 -<> and returns it at the location pointed to by _s_. +The `nng_req0_open()` function creates a xref:nng_req.7.adoc[_req_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_req0_open_raw()` function creates a <> version 0 -<> in -<> mode +The `nng_req0_open_raw()` function creates a xref:nng_req.7.adoc[_req_] version 0 +xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -48,8 +48,8 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_rep.7.adoc[nng_rep(7)], +xref:nng_req.7.adoc[nng_req(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_respondent.7.adoc b/docs/man/nng_respondent.7.adoc index a22080044..f6f1538f8 100644 --- a/docs/man/nng_respondent.7.adoc +++ b/docs/man/nng_respondent.7.adoc @@ -35,11 +35,11 @@ election in cluster configurations, as well as certain kinds of service discovery problems. The _respondent_ protocol is the respondent side, and the -<> protocol is the surveyor side. +xref:nng_surveyor.7.adoc[_surveyor_] protocol is the surveyor side. === Socket Operations -The `<>` functions create a +The xref:nng_respondent_open.3.adoc[`nng_respondent0_open()`] functions create a respondent socket. 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 @@ -47,13 +47,13 @@ reply will be sent to surveyor from whom the last survey was received. Respondents may discard a survey by simply not replying to it. -Raw mode sockets (set with `<>`) +Raw mode sockets (set with xref:nng_options.5.adoc#NNG_OPT_RAW[`NNG_OPT_RAW`]) ignore all these restrictions. === Context Operations -This protocol supports the creation of <> for concurrent -use cases using `<>`. +This protocol supports the creation of xref:nng_ctx.5.adoc[contexts] for concurrent +use cases using xref:nng_ctx_open.3.adoc[`nng_ctx_open()`]. Incoming surveys will be routed to and received by only one context. Additional surveys may be received by other contexts in parallel. @@ -79,13 +79,13 @@ The _respondent_ protocol has no protocol-specific options. (((backtrace))) The _respondent_ protocol uses a _backtrace_ in the header. -This is more fully documented in the <> manual. +This is more fully documented in the xref:nng_surveyor.7.adoc[_surveyor_] manual. // TODO: Insert reference to RFC. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_respondent_open.3.adoc[nng_respondent_open(3)], +xref:nng_surveyor.7.adoc[nng_surveyor(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_respondent_open.3.adoc b/docs/man/nng_respondent_open.3.adoc index 65122680c..5a5167d26 100644 --- a/docs/man/nng_respondent_open.3.adoc +++ b/docs/man/nng_respondent_open.3.adoc @@ -28,14 +28,14 @@ int nng_respondent0_open_raw(nng_socket *s); == DESCRIPTION The `nng_respondent0_open()` function creates a -<> -version 0 <> and returns it at the location +xref:nng_respondent.7.adoc[_respondent_] +version 0 xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. The `nng_respondent0_open_raw()` function creates a -<> -version 0 <> in -<> mode and returns it at the location pointed to by _s_. +xref:nng_respondent.7.adoc[_respondent_] +version 0 xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -50,7 +50,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_respondent.7.adoc[nng_respondent(7)], +xref:nng_surveyor.7.adoc[nng_surveyor(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc index ef31cbbed..389ba0794 100644 --- a/docs/man/nng_send.3.adoc +++ b/docs/man/nng_send.3.adoc @@ -25,16 +25,16 @@ int nng_send(nng_socket s, void *data, size_t size, int flags); == DESCRIPTION The `nng_send()` function sends a message containing the _data_ of -length _size_ using the <> _s_. +length _size_ using the xref:nng_socket.5.adoc[socket] _s_. NOTE: The semantics of what sending a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with an <> socket the data is broadcast, so that +(For example, with an xref:nng_pub.7.adoc[_nng_] socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -`<>` or a similar function.) +xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.) Furthermore, some protocols may not support sending data (such as -<>) or may require other conditions. -(For example, <> sockets cannot normally send data, +xref:nng_sub.7.adoc[_sub_]) or may require other conditions. +(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which are responses to requests, until they have first received a request.) The _flags_ may contain either of (or neither of) the following values: @@ -48,12 +48,12 @@ The _flags_ may contain either of (or neither of) the following values: then the function will block if such a condition exists. `NNG_FLAG_ALLOC`:: - The _data_ was allocated using `<>`, or was - obtained from a call to `<>` with + The _data_ was allocated using xref:nng_alloc.3.adoc[`nng_alloc()`], or was + obtained from a call to xref:nng_recv.3.adoc[`nng_recv()`] with the `NNG_FLAG_ALLOC` flag. If this function returns success, then the _data_ is "owned" by the function, and it will assume responsibility for calling - `<>` when it is no longer needed. + xref:nng_free.3.adoc[`nng_free()`] when it is no longer needed. In the absence of this flag, the _data_ is copied by the implementation before the function returns to the caller. @@ -64,7 +64,7 @@ NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may be queues between the sender and the receiver. Furthermore, there is no guarantee that the message has actually been delivered. Finally, with some protocols, the semantic is implicitly `NNG_FLAG_NONBLOCK`, -such as with <> sockets, which are best-effort delivery only. +such as with xref:nng_pub.7.adoc[_pub_] sockets, which are best-effort delivery only. IMPORTANT: When using `NNG_FLAG_ALLOC`, it is important that the value of _size_ match the actual allocated size of the data. @@ -91,10 +91,10 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_alloc.3.adoc[nng_alloc(3)], +xref:nng_free.3.adoc[nng_free(3)], +xref:nng_recv.3.adoc[nng_recv(3)], +xref:nng_sendmsg.3.adoc[nng_sendmsg(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_send_aio.3.adoc b/docs/man/nng_send_aio.3.adoc index ae6b6b7d1..6ae66b17d 100644 --- a/docs/man/nng_send_aio.3.adoc +++ b/docs/man/nng_send_aio.3.adoc @@ -24,15 +24,15 @@ void nng_send_aio(nng_socket s, nng_aio *aio); == DESCRIPTION -The `nng_send_aio()` sends a <> using the -<> _s_ asynchronously. +The `nng_send_aio()` sends a xref:nng_msg.5.adoc[message] using the +xref:nng_socket.5.adoc[socket] _s_ asynchronously. The message to send must have previously been set on the _aio_ -using the `<>` function. +using the xref:nng_aio_set_msg.3.adoc[`nng_aio_set_msg()`] function. The function assumes "`ownership`" of the message. If the message was successfully queued for delivery to the socket, -then the _aio_ will be completed, and `<>` +then the _aio_ will be completed, and xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return zero. In this case the socket will dispose of the message when it is finished with it. @@ -45,22 +45,22 @@ socket, or in flight over physical media. If the operation fails for any reason (including cancellation or timeout), then the _aio_ callback will be executed and -`<>` +xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return a non-zero error status. In this case, the callback has a responsibility to retrieve the message from the _aio_ with -`<>` and dispose of it appropriately. +xref:nng_aio_get_msg.3.adoc[`nng_aio_get_msg()`] and dispose of it appropriately. (This may include retrying the send operation on the same or a different -socket, or deallocating the message with `<>`.) +socket, or deallocating the message with xref:nng_msg_free.3.adoc[`nng_msg_free()`].) NOTE: The semantics of what sending a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a <> socket the data is broadcast, so that +(For example, with a xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -`<>` or a similar function.) +xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.) Furthermore, some protocols may not support sending (such as -<>) or may require other conditions. -(For example, <> sockets cannot normally send data, which +xref:nng_sub.7.adoc[_sub_]) or may require other conditions. +(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which are responses to requests, until they have first received a request.) == RETURN VALUES @@ -81,11 +81,11 @@ None. (The operation completes asynchronously.) == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sendmsg.3.adoc b/docs/man/nng_sendmsg.3.adoc index 10b8d3706..1fe46d423 100644 --- a/docs/man/nng_sendmsg.3.adoc +++ b/docs/man/nng_sendmsg.3.adoc @@ -36,16 +36,16 @@ to dispose of the _msg_, which may include freeing it, sending it to another socket, or simply trying again later. TIP: Using this function gives access to the message structure, and may -offer more functionality than the simpler `<>` function. +offer more functionality than the simpler xref:nng_send.3.adoc[`nng_send()`] function. NOTE: The semantics of what sending a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a <> socket the data is broadcast, so that +(For example, with a xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -`<>` or a similar function.) +xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.) Furthermore, some protocols may not support sending (such as -<>) or may require other conditions. -(For example, <> sockets cannot normally send data, which +xref:nng_sub.7.adoc[_sub_]) or may require other conditions. +(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which are responses to requests, until they have first received a request.) The _flags_ may contain the following value: @@ -64,7 +64,7 @@ NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may be queues between the sender and the receiver. Furthermore, there is no guarantee that the message has actually been delivered. Finally, with some protocols, the semantic is implicitly `NNG_FLAG_NONBLOCK`, -such as with <> sockets, which are best-effort delivery only. +such as with xref:nng_pub.7.adoc[_pub_] sockets, which are best-effort delivery only. == RETURN VALUES @@ -85,10 +85,10 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_recvmsg.3.adoc[nng_recvmsg(3)], +xref:nng_send.3.adoc[nng_send(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc index 1a3eb2339..cdb540c7b 100644 --- a/docs/man/nng_setopt.3.adoc +++ b/docs/man/nng_setopt.3.adoc @@ -46,7 +46,7 @@ The `nng_setopt()` functions are used to configure options for the socket _s_. The actual options that may be configured in this way vary, and are specified by _opt_. -A number of them are documented in <>. +A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific and protocol-specific options are documented with the transports and protocols themselves. @@ -73,14 +73,14 @@ The _ival_ is passed to the option. `nng_setopt_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_setopt_ptr()`:: This function is used to pass a pointer, _ptr_, to structured data. The data referenced by _ptr_ is generally managed by other functions. For example, TLS configuration objects created with -(`<>`) +(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`]) can be passed this way. NOTE: This form is somewhat special in that the object is generally @@ -118,10 +118,10 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_getopt.3.adoc[nng_getopt(3)], +xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)], +xref:nng_listener_setopt.3.adoc[nng_listener_setopt(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sleep_aio.3.adoc b/docs/man/nng_sleep_aio.3.adoc index 6592b7b0d..323e60395 100644 --- a/docs/man/nng_sleep_aio.3.adoc +++ b/docs/man/nng_sleep_aio.3.adoc @@ -29,7 +29,7 @@ causing the callback for _aio_ to be executed after _msec_ milliseconds. If the sleep finishes completely, the result will always be zero. NOTE: If a timeout is set on _aio_ using -`<>`, and it is shorter +xref:nng_aio_set_timeout.3.adoc[`nng_aio_set_timeout()`], and it is shorter than _msec_, then the sleep will wake up early, with a result code of `NNG_ETIMEDOUT`. @@ -44,10 +44,10 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_set_timeout.3.adoc[nng_aio_set_timeout(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sockaddr.5.adoc b/docs/man/nng_sockaddr.5.adoc index e8bae4259..827f6ac8f 100644 --- a/docs/man/nng_sockaddr.5.adoc +++ b/docs/man/nng_sockaddr.5.adoc @@ -48,8 +48,8 @@ addresses, IPC paths, and so forth. **** The name `sockaddr` is based on its similarity with POSIX `struct sockaddr`, but in the _nng_ library, these addresses are more closely affiliated with -instances of `<>` -than of `<>`. +instances of xref:nng_pipe.5.adoc[`nng_pipe`] +than of xref:nng_socket.5.adoc[`nng_socket`]. The naming confusion is unfortunate. **** @@ -65,20 +65,20 @@ The values of `s_family` are as follows: [horizontal] `NNG_AF_UNSPEC`:: Invalid address, no other valid fields. -`NNG_AF_INPROC`:: Address for intraprocess communication (<>). The `s_inproc` member is valid. -`NNG_AF_IPC`:: Address for interprocess communication (<>). The `s_path` member is valid. +`NNG_AF_INPROC`:: Address for intraprocess communication (xref:nng_inproc.7.adoc[nng_inproc(7)]). The `s_inproc` member is valid. +`NNG_AF_IPC`:: Address for interprocess communication (xref:nng_ipc.7.adoc[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 (<>). The `s_zt` member is valid. +`NNG_AF_ZT`:: Address for ZeroTier transport (xref:nng_zerotier.7.adoc[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] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_sockaddr_in.5.adoc[nng_sockaddr_in(5)], +xref:nng_sockaddr_in6.5.adoc[nng_sockaddr_in6(5)], +xref:nng_sockaddr_inproc.5.adoc[nng_sockaddr_inproc(5)], +xref:nng_sockaddr_ipc.5.adoc[nng_sockaddr_ipc(5)], +xref:nng_sockaddr_zt.5.adoc[nng_sockaddr_zt(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sockaddr_in.5.adoc b/docs/man/nng_sockaddr_in.5.adoc index 0bdf5006a..a7ef13b6f 100644 --- a/docs/man/nng_sockaddr_in.5.adoc +++ b/docs/man/nng_sockaddr_in.5.adoc @@ -33,12 +33,12 @@ typedef struct { == DESCRIPTION (((socket, address, IPv4))) -An `nng_sockaddr_in` is the flavor of `<>` +An `nng_sockaddr_in` is the flavor of xref:nng_sockaddr.5.adoc[`nng_sockaddr`] used to represent TCP (and sometimes UDP) addresses, including the Internet Protocol (IP) address and port number.(((port number, TCP))) This structure is used with IPv4 addresses. -A different structure, `<>`, is used +A different structure, xref:nng_sockaddr_in6.5.adoc[`nng_sockaddr_in6`], is used for IPv6 addresses. The following structure members are present: @@ -65,7 +65,7 @@ _not_ the same, and they may not be used interchangeably. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_sockaddr_in6.5.adoc[nng_sockaddr_in6(5)], +xref:nng_tcp.7.adoc[nng_tcp(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sockaddr_in6.5.adoc b/docs/man/nng_sockaddr_in6.5.adoc index 47a61e8c1..804056c52 100644 --- a/docs/man/nng_sockaddr_in6.5.adoc +++ b/docs/man/nng_sockaddr_in6.5.adoc @@ -33,12 +33,12 @@ typedef struct { == DESCRIPTION (((socket, address, IPv6))) -An `nng_sockaddr_in6` is the flavor of `<>` +An `nng_sockaddr_in6` is the flavor of xref:nng_sockaddr.5.adoc[`nng_sockaddr`] used to represent TCP (and sometimes UDP) addresses, including the Internet Protocol (IP) address and port number.(((port number, TCP))) This structure is used with IPv6 addresses. -A different structure, `<>`, is used +A different structure, xref:nng_sockaddr_in.5.adoc[`nng_sockaddr_in`], is used for IPv4 addresses. The following structure members are present: @@ -65,7 +65,7 @@ _not_ the same, and they may not be used interchangeably. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_sockaddr_in.5.adoc[nng_sockaddr_in(5)], +xref:nng_tcp.7.adoc[nng_tcp(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sockaddr_inproc.5.adoc b/docs/man/nng_sockaddr_inproc.5.adoc index b3dafd1a8..529e87587 100644 --- a/docs/man/nng_sockaddr_inproc.5.adoc +++ b/docs/man/nng_sockaddr_inproc.5.adoc @@ -32,9 +32,9 @@ typedef struct { == DESCRIPTION (((socket, address, inproc))) -An `nng_sockaddr_inproc` is the flavor of `<>` +An `nng_sockaddr_inproc` is the flavor of xref:nng_sockaddr.5.adoc[`nng_sockaddr`] used to represent addresses associated with intra-process communication -using the <> transport. +using the xref:nng_inproc.7.adoc[_inproc_] transport. The following structure members are present: @@ -54,6 +54,6 @@ Furthermore, the size is guaranteed to be at least 128. == SEE ALSO [.text-left] -<>, -<> -<> +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_inproc.7.adoc[nng_inproc(7)] +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sockaddr_ipc.5.adoc b/docs/man/nng_sockaddr_ipc.5.adoc index 569d8694e..52a57cecd 100644 --- a/docs/man/nng_sockaddr_ipc.5.adoc +++ b/docs/man/nng_sockaddr_ipc.5.adoc @@ -32,9 +32,9 @@ typedef struct { == DESCRIPTION (((socket, address, IPC))) -An `nng_sockaddr_ipc` is the flavor of `<>` +An `nng_sockaddr_ipc` is the flavor of xref:nng_sockaddr.5.adoc[`nng_sockaddr`] used to represent addresses associated with IPC communication -using the <> transport. +using the xref:nng_ipc.7.adoc[_ipc_] transport. The following structure members are present: @@ -66,6 +66,6 @@ longer than 128 bytes, including the `ipc://` prefix. == SEE ALSO [.text-left] -<>, -<> -<> +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_ipc.7.adoc[nng_ipc(7)] +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sockaddr_zt.5.adoc b/docs/man/nng_sockaddr_zt.5.adoc index 0019116a6..61c77644d 100644 --- a/docs/man/nng_sockaddr_zt.5.adoc +++ b/docs/man/nng_sockaddr_zt.5.adoc @@ -34,10 +34,10 @@ typedef struct { == DESCRIPTION (((socket, address, ZeroTier))) -An `nng_sockaddr_zt` is the flavor of `<>` +An `nng_sockaddr_zt` is the flavor of xref:nng_sockaddr.5.adoc[`nng_sockaddr`] used to represent ZeroTier addresses, including the (((port number, ZeroTier)))port number used by the -<> transport. +xref:nng_zerotier.7.adoc[_zt_] transport. IMPORTANT: The ZeroTier transport, and the details of this structure, are still considered experimental, and subject to change. @@ -62,7 +62,7 @@ The following structure members are present: `sa_port`:: This field holds the "`port number`" used by the - <> transport to distinguish different + xref:nng_zerotier.7.adoc[_zt_] transport to distinguish different sockets. This value in native byte order.(((port number, ZeroTier))) A zero value here indicates that a port number should be chosen @@ -77,6 +77,6 @@ the Scalability Protocols binding for them. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_zerotier.7.adoc[nng_zerotier(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_socket.5.adoc b/docs/man/nng_socket.5.adoc index f0aad0c6d..b101969ab 100644 --- a/docs/man/nng_socket.5.adoc +++ b/docs/man/nng_socket.5.adoc @@ -27,9 +27,9 @@ typedef struct nng_socket_s nng_socket; An `nng_socket`(((socket))) is a handle to an underlying "`socket`" object. All communication between the application and remote Scalability Protocol peers is done through sockets. -A given socket can have multiple dialers (`<>`) -and/or listeners (`<>`), and multiple -pipes (`<>`), and +A given socket can have multiple dialers (xref:nng_dialer.5.adoc[`nng_dialer`]) +and/or listeners (xref:nng_listener.5.adoc[`nng_listener`]), and multiple +pipes (xref:nng_pipe.5.adoc[`nng_pipe`]), and may be connected to multiple transports at the same time. However, a given socket will have exactly one "`protocol`" associated with it, and is responsible for any state machines or other protocol-specific logic. @@ -40,9 +40,9 @@ Passing structures this way ensures gives the compiler a chance to perform accurate type checks in functions passing values of this type. Each `nng_socket` is created by a protocol-specific constructor, such as -`<>`. +xref:nng_rep_open.3.adoc[`nng_rep_open()`]. When the socket is no longer needed, it can be closed with -`<>`. +xref:nng_close.3.adoc[`nng_close()`]. [[NNG_SOCKET_INITIALIZER]] === Initialization @@ -60,12 +60,12 @@ nng_socket s = NNG_SOCKET_INITIALIZER; == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_close.3.adoc[nng_close(3)], +xref:nng_getopt.3.adoc[nng_getopt(3)], +xref:nng_setopt.3.adoc[nng_setopt(3)], +xref:nng_socket_id.3.adoc[nng_socket_id(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng_listener.5.adoc[nng_listener(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_socket_get.3.adoc b/docs/man/nng_socket_get.3.adoc index d077207dc..6c2ec87ee 100644 --- a/docs/man/nng_socket_get.3.adoc +++ b/docs/man/nng_socket_get.3.adoc @@ -43,9 +43,9 @@ int nng_socket_get_addr(nng_socket s, const char *opt, nng_sockaddr *addrp); (((options, socket))) The `nng_socket_get()` functions are used to retrieve option values for -the <> _s_. +the xref:nng_socket.5.adoc[socket] _s_. The actual options that may be retrieved in this way vary. -A number of them are documented in <>. +A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -87,7 +87,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_socket_get_ms()`:: -This function is used to retrieve time <> +This function is used to retrieve time xref:nng_duration.5.adoc[durations] (such as timeouts), stored in _durp_ as a number of milliseconds. (The special value ((`NNG_DUR_INFINITE`)) means an infinite amount of time, and the special value ((`NNG_DUR_DEFAULT`)) means a context-specific default.) @@ -104,9 +104,9 @@ typically for buffer sizes, message maximum sizes, and similar options. `nng_socket_get_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_socket_get_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -131,14 +131,14 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_dialer_get.3.adoc[nng_dialer_get(3)], +xref:nng_listener_get.3.adoc[nng_listener_get(3)], +xref:nng_pipe_get.3.adoc[nng_pipe_get(3)], +xref:nng_socket_set.3.adoc[nng_socket_set(3)], +xref:nng_strdup.3.adoc[nng_strdup(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_strfree.3.adoc[nng_strfree(3)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_socket_id.3.adoc b/docs/man/nng_socket_id.3.adoc index 30a59beca..3501f6b29 100644 --- a/docs/man/nng_socket_id.3.adoc +++ b/docs/man/nng_socket_id.3.adoc @@ -29,11 +29,11 @@ if it is valid. Otherwise it returns `-1`. NOTE: A socket is considered valid if it was ever opened with a protocol -constructor, such as the `<>` function. +constructor, such as the xref:nng_req_open.3.adoc[`nng_req0_open()`] function. Sockets that are allocated on the stack or statically should be initialized with the macro -`<>` to ensure that -they cannot be confused with a valid socket before they are opened. +xref:nng_socket.5.adoc#NNG_SOCKET_INITIALIZER[`NNG_SOCKET_INITIALIZER`] +to ensure that they cannot be confused with a valid socket before they are opened. == RETURN VALUES @@ -47,5 +47,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_socket_set.3.adoc b/docs/man/nng_socket_set.3.adoc index bb84861a2..0b6df4f9a 100644 --- a/docs/man/nng_socket_set.3.adoc +++ b/docs/man/nng_socket_set.3.adoc @@ -43,7 +43,7 @@ The `nng_socket_set()` functions are used to configure options for the socket _s_. The actual options that may be configured in this way vary, and are specified by _opt_. -A number of them are documented in <>. +A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific and protocol-specific options are documented with the transports and protocols themselves. @@ -70,14 +70,14 @@ The _ival_ is passed to the option. `nng_socket_set_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_socket_set_ptr()`:: This function is used to pass a pointer, _ptr_, to structured data. The data referenced by _ptr_ is generally managed by other functions. For example, TLS configuration objects created with -(`<>`) +(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`]) can be passed this way. NOTE: This form is somewhat special in that the object is generally @@ -115,10 +115,10 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_socket_get.3.adoc[nng_socket_get(3)], +xref:nng_dialer_set.3.adoc[nng_dialer_set(3)], +xref:nng_listener_set.3.adoc[nng_listener_set(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat.5.adoc b/docs/man/nng_stat.5.adoc index 54b548837..4382e4b03 100644 --- a/docs/man/nng_stat.5.adoc +++ b/docs/man/nng_stat.5.adoc @@ -25,31 +25,31 @@ typedef struct nng_stat nng_stat; == DESCRIPTION An `nng_stat`(((statistic))) represents a statistic. -All statistics have names (`<>`) and -descriptions (`<>`), and are -typed (`<>`). +All statistics have names (xref:nng_stat_name.3.adoc[`nng_stat_name()`]) and +descriptions (xref:nng_stat_desc.3.adoc[`nng_stat_desc()`]), and are +typed (xref:nng_stat_type.3.adoc[`nng_stat_type()`]). Most statistics are numeric, -and thus carry a value (`<>`) -and frequently also a unit that the value measures (`<>`). +and thus carry a value (xref:nng_stat_value.3.adoc[`nng_stat_value()`]) +and frequently also a unit that the value measures (xref:nng_stat_unit.3.adoc[`nng_stat_unit()`]). -Some statistics however, are simply strings (`<>`), +Some statistics however, are simply strings (xref:nng_stat_string.3.adoc[`nng_stat_string()`]), and thus carry no numeric value. Statistics are organized as a tree, and any given statistic can have siblings -(`<>`). +(xref:nng_stat_next.3.adoc[`nng_stat_next()`]). Note however that generally only `NNG_STAT_SCOPE` statistics, which are act as placeholders in the tree (and carry no value), -will have children (`<>`). +will have children (xref:nng_stat_child.3.adoc[`nng_stat_child()`]). -A tree of statistics is collected using `<>`, -and can be freed when no longer needed with `<>`. +A tree of statistics is collected using xref:nng_stats_get.3.adoc[`nng_stats_get()`], +and can be freed when no longer needed with xref:nng_stats_free.3.adoc[`nng_stats_free()`]. This collection process is generally performed in a way to minimize impact to running operations, but there is still some impact caused by collection of statistics. The time when a statistic`'s value is captured can be obtained using -`<>`, which is useful for +xref:nng_stat_timestamp.3.adoc[`nng_stat_timestamp()`], which is useful for measuring rates of change in certain statistics. NOTE: The presence, names, and meanings of any given statistic are @@ -63,16 +63,16 @@ in order to reduce program size and run-time overheads. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_free.3.adoc[nng_stats_free(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stat_desc.3.adoc[nng_stat_desc(3)], +xref:nng_stat_name.3.adoc[nng_stat_name(3)], +xref:nng_stat_next.3.adoc[nng_stat_next(3)], +xref:nng_stat_string.3.adoc[nng_stat_string(3)], +xref:nng_stat_timestamp.3.adoc[nng_stat_timestamp(3)], +xref:nng_stat_type.3.adoc[nng_stat_type(3)], +xref:nng_stat_unit.3.adoc[nng_stat_unit(3)], +xref:nng_stat_value.3.adoc[nng_stat_value(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_child.3.adoc b/docs/man/nng_stat_child.3.adoc index c86e368ef..123ca82d2 100644 --- a/docs/man/nng_stat_child.3.adoc +++ b/docs/man/nng_stat_child.3.adoc @@ -30,7 +30,7 @@ The `nng_stat_child()` function returns the first child statistic of the statistic _parent_. If no children are present, then `NULL` is returned. -TIP: Only statistics with type (see `<>`) +TIP: Only statistics with type (see xref:nng_stat_type.3.adoc[`nng_stat_type()`]) of `NNG_STAT_SCOPE` will have children. == RETURN VALUES @@ -44,8 +44,8 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_next.3.adoc[nng_stat_next(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_desc.3.adoc b/docs/man/nng_stat_desc.3.adoc index af6a76f15..e87849d31 100644 --- a/docs/man/nng_stat_desc.3.adoc +++ b/docs/man/nng_stat_desc.3.adoc @@ -45,8 +45,8 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_name.3.adoc[nng_stats_name(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_name.3.adoc b/docs/man/nng_stat_name.3.adoc index 4aa7455d9..87fac5723 100644 --- a/docs/man/nng_stat_name.3.adoc +++ b/docs/man/nng_stat_name.3.adoc @@ -41,7 +41,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_next.3.adoc b/docs/man/nng_stat_next.3.adoc index ba9e770df..00caa5c86 100644 --- a/docs/man/nng_stat_next.3.adoc +++ b/docs/man/nng_stat_next.3.adoc @@ -41,8 +41,8 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_string.3.adoc b/docs/man/nng_stat_string.3.adoc index 44173c86c..3323fef3a 100644 --- a/docs/man/nng_stat_string.3.adoc +++ b/docs/man/nng_stat_string.3.adoc @@ -27,7 +27,7 @@ const char *nng_stat_string(nng_stat *stat); == DESCRIPTION The `nng_stat_string()` function returns a string value for the statistic _stat_, -which must be of type `NNG_STAT_STRING` (see `<>`). +which must be of type `NNG_STAT_STRING` (see xref:nng_stat_type.3.adoc[`nng_stat_type(3)`]). If the statistic is not of type `NNG_STAT_STRING`, then `NULL` will be returned. @@ -43,9 +43,9 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat_type.3.adoc[nng_stats_type(3)], +xref:nng_stat_value.3.adoc[nng_stats_value(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_timestamp.3.adoc b/docs/man/nng_stat_timestamp.3.adoc index 78e395b2c..74d827e86 100644 --- a/docs/man/nng_stat_timestamp.3.adoc +++ b/docs/man/nng_stat_timestamp.3.adoc @@ -37,7 +37,7 @@ TIP: These values are intended to facilitate calculation of rates, by comparing values from one snapshot with a subsequent one. TIP: The values used here have the same offset as the -`<>` supplementation function. +xref:nng_clock.3supp.adoc[`nng_clock()`] supplemental function. This can be useful when converting these values to local clock time. == RETURN VALUES @@ -52,9 +52,9 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat_value.3.adoc[nng_stat_value(3)], +xref:nng_clock.3supp.adoc[nng_clock(3supp)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_type.3.adoc b/docs/man/nng_stat_type.3.adoc index b494fed24..a2578e5e7 100644 --- a/docs/man/nng_stat_type.3.adoc +++ b/docs/man/nng_stat_type.3.adoc @@ -42,7 +42,7 @@ The returned type will be one of the following values: ((`NNG_STAT_SCOPE`)):: This is a placeholder providing scope, and carries no value on its own. Instead it is a parent node with child statistics (see -`<>`.) +xref:nng_stat_child.3.adoc[`nng_stat_child()`].) ((`NNG_STAT_LEVEL`)):: This is a numeric statistic, but its value is a level, so rate calculations @@ -58,12 +58,12 @@ divided by the interval over which the change occurred.) ((`NNG_STAT_STRING`)):: This is a string, and carries no numeric value. -Instead the `<>` function +Instead the xref:nng_stat_string.3.adoc[`nng_stat_string()`] function should be used to obtain the value. ((`NNG_STAT_BOOLEAN`)):: This is a boolean value. -The `<>` function will return zero +The xref:nng_stat_value.3.adoc[`nng_stat_value()`] function will return zero to represent a `false` value, and one to represent a `true` value. ((`NNG_STAT_ID`)): @@ -72,7 +72,7 @@ These are generally immutable values that represent an identity that might be used with another interface. TIP: For `NNG_STAT_COUNTER` and `NNG_STAT_LEVEL` statistics, the -`<>` function will provide more +xref:nng_stat_unit.3.adoc[`nng_stat_unit()`] function will provide more detail about the units measured by the static. == RETURN VALUES @@ -86,10 +86,10 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat_string.3.adoc[nng_stat_string(3)], +xref:nng_stat_unit.3.adoc[nng_stat_unit(3)], +xref:nng_stat_value.3.adoc[nng_stat_value(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_unit.3.adoc b/docs/man/nng_stat_unit.3.adoc index 895e1a101..f7136e1f2 100644 --- a/docs/man/nng_stat_unit.3.adoc +++ b/docs/man/nng_stat_unit.3.adoc @@ -42,14 +42,14 @@ The returned value will be one of the following values: ((`NNG_UNIT_NONE`)):: There are no particular units measured. In some cases there may be units, but the type of the unit will be obvious -from the name (see `<>`) of the statistic. +from the name (see xref:nng_stat_name.3.adoc[`nng_stat_name()`]) of the statistic. ((`NNG_UNIT_BYTES`)):: The statistic is a count of bytes. ((`NNG_UNIT_MESSAGES`)):: The statistic is a count of messages. -Typically, one message corresponds to a single `<>` structure. +Typically, one message corresponds to a single xref:nng_msg.5.adoc[`nng_msg`] structure. ((`NNG_UNIT_MILLIS`)):: The statistic is a count of milliseconds. @@ -58,7 +58,7 @@ The statistic is a count of milliseconds. The statistic is a count of some other type of event. For statistics that are neither `NNG_STAT_COUNTER` nor `NNG_STAT_LEVEL` -type (see `<>`), the unit will +type (see xref:nng_stat_type.3.adoc[`nng_stat_type()`]), the unit will generally be `NNG_UNIT_NONE`. TIP: Normally rates can be calculated for `NNG_STAT_COUNTER` values for @@ -76,11 +76,11 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat_name.3.adoc[nng_stat_name(3)], +xref:nng_stat_type.3.adoc[nng_stat_type(3)], +xref:nng_stat_value.3.adoc[nng_stat_value(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stat_value.3.adoc b/docs/man/nng_stat_value.3.adoc index c33e376ce..6f1b92010 100644 --- a/docs/man/nng_stat_value.3.adoc +++ b/docs/man/nng_stat_value.3.adoc @@ -30,7 +30,7 @@ The `nng_stat_value()` function returns a numeric value for the statistic _stat_ If the statistic has a boolean value, then zero is returned for `false`, and one is returned for `true`. Otherwise, if the statistic is not of numeric type, then zero is returned. -See `<>` for a description of statistic types. +See xref:nng_stat_type.3.adoc[`nng_stat_type()`] for a description of statistic types. == RETURN VALUES @@ -43,9 +43,9 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat_type.3.adoc[nng_stat_type(3)], +xref:nng_stat_unit.3.adoc[nng_stat_unit(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stats_free.3.adoc b/docs/man/nng_stats_free.3.adoc index 285bf2483..ce900b7e3 100644 --- a/docs/man/nng_stats_free.3.adoc +++ b/docs/man/nng_stats_free.3.adoc @@ -28,7 +28,7 @@ void nng_stats_free(nng_stat *); The `nng_stats_free()` function deallocates a statistics snapshot previously collected with -`<>`. +xref:nng_stats_get.3.adoc[`nng_stats_get()`]. After calling this, all values associated with the snapshot are invalidated. @@ -46,6 +46,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_stats_get.3.adoc[nng_stats_get(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stats_get.3.adoc b/docs/man/nng_stats_get.3.adoc index 1d16cadb2..5cbb26248 100644 --- a/docs/man/nng_stats_get.3.adoc +++ b/docs/man/nng_stats_get.3.adoc @@ -37,12 +37,12 @@ statistic of type `NNG_STAT_SCOPE` that carries no value, and which has an empty name. This parent statistic is returned through the _statsp_ pointer. -The `<>` and -`<>` function can be used to +The xref:nng_stat_child.3.adoc[`nng_stat_child()`] and +xref:nng_stat_next.3.adoc[`nng_stat_next()`] function can be used to iterate over the the tree. When no longer needed, the statistics can be freed with the -`<>` function, but that +xref:nng_stats_free.3.adoc[`nng_stats_free()`] function, but that function must be called only with the root statistic that is returned through the _statsp_ pointer. @@ -72,15 +72,15 @@ and `NULL` otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_stats_free.3.adoc[nng_stats_free(3)], +xref:nng_stat_child.3.adoc[nng_stat_child(3)], +xref:nng_stat_desc.3.adoc[nng_stat_desc(3)], +xref:nng_stat_name.3.adoc[nng_stat_name(3)], +xref:nng_stat_next.3.adoc[nng_stat_next(3)], +xref:nng_stat_string.3.adoc[nng_stat_string(3)], +xref:nng_stat_type.3.adoc[nng_stat_type(3)], +xref:nng_stat_timestamp.3.adoc[nng_stat_timestamp(3)], +xref:nng_stat_unit.3.adoc[nng_stat_unit(3)], +xref:nng_stat_value.3.adoc[nng_stat_value(3)], +xref:nng_stat.5.adoc[nng_stat(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_strdup.3.adoc b/docs/man/nng_strdup.3.adoc index 9c2eda4f0..91c4854dd 100644 --- a/docs/man/nng_strdup.3.adoc +++ b/docs/man/nng_strdup.3.adoc @@ -26,14 +26,14 @@ char *nng_strdup(const char *src); The `nng_strdup()` duplicates the string _src_ and returns it. -This is logically equivalent to using `<>` +This is logically equivalent to using xref:nng_alloc.3.adoc[`nng_alloc()`] to allocate a region of memory of `strlen(s) + 1` bytes, and then using `strcpy()` to copy the string into the destination before returning it. The returned string should be deallocated with -`<>`, or may be deallocated using the -`<>` using the length of the returned string plus +xref:nng_strfree.3.adoc[`nng_strfree()`], or may be deallocated using the +xref:nng_free.3.adoc[`nng_free()`] using the length of the returned string plus one (for the `NUL` terminating byte). IMPORTANT: Do not use the system `free()` or similar functions to deallocate @@ -51,6 +51,6 @@ treated the same as `NNG_ENOMEM`. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_alloc.3.adoc[nng_alloc(3)], +xref:nng_free.3.adoc[nng_free(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_strerror.3.adoc b/docs/man/nng_strerror.3.adoc index c8de5ecd0..61a5f8a53 100644 --- a/docs/man/nng_strerror.3.adoc +++ b/docs/man/nng_strerror.3.adoc @@ -44,5 +44,5 @@ by a `NUL` byte. == SEE ALSO [.text-left] -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_strfree.3.adoc b/docs/man/nng_strfree.3.adoc index b923e8e0c..9250b834e 100644 --- a/docs/man/nng_strfree.3.adoc +++ b/docs/man/nng_strfree.3.adoc @@ -25,20 +25,20 @@ void nng_strfree(char *str); == DESCRIPTION The `nng_strfree()` function deallocates the string _str_. -This is equivalent to using `<>` with +This is equivalent to using xref:nng_free.3.adoc[`nng_free()`] with the length of _str_ plus one (for the `NUL` terminating byte) as the size. IMPORTANT: This should only be used with strings that were allocated -by `<>` or -`<>`. +by xref:nng_strdup.3.adoc[`nng_strdup()`] or +xref:nng_alloc.3.adoc[`nng_alloc()`]. In all cases, the allocation size of the string must be the same as `strlen(__str__) + 1`. IMPORTANT: Consequently, if the a string created with -`<>` is modified to be shorter, then +xref:nng_strdup.3.adoc[`nng_strdup()`] is modified to be shorter, then it is incorrect to call this function. -(The `<>` function can be used instead in that +(The xref:nng_free.3.adoc[`nng_free()`] function can be used instead in that case, using the length of the original string plus one for the size.) == RETURN VALUES @@ -52,7 +52,7 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_alloc.3.adoc[nng_alloc(3)], +xref:nng_free.3.adoc[nng_free(3)], +xref:nng_strdup.3.adoc[nng_strdup(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sub.7.adoc b/docs/man/nng_sub.7.adoc index 9ff751ca3..cd9af7275 100644 --- a/docs/man/nng_sub.7.adoc +++ b/docs/man/nng_sub.7.adoc @@ -29,7 +29,7 @@ In this pattern, a publisher sends data, which is broadcast to all subscribers. The subscribing applications only see the data to which they have subscribed. The _sub_ protocol is the subscriber side, and the -<> protocol is the publisher side. +xref:nng_pub.7.adoc[_pub_] protocol is the publisher side. NOTE: In this implementation, the publisher delivers all messages to all subscribers. @@ -43,7 +43,7 @@ Applications should construct their messages accordingly. === Socket Operations -The `<>` functions create a subscriber socket. +The xref:nng_sub_open.3.adoc[`nng_sub0_open()`] functions create a subscriber socket. This socket may be used to receive messages, but is unable to send them. Attempts to send messages will result in `NNG_ENOTSUP`. @@ -80,6 +80,6 @@ The _sub_ protocol has no protocol-specific headers. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_sub_open.3.adoc[nng_sub_open(3)], +xref:nng_pub.7.adoc[nng_pub(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sub_open.3.adoc b/docs/man/nng_sub_open.3.adoc index 63974aeef..ea01673cc 100644 --- a/docs/man/nng_sub_open.3.adoc +++ b/docs/man/nng_sub_open.3.adoc @@ -27,12 +27,12 @@ int nng_sub0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_sub0_open()` function creates a <> version 0 -<> and returns it at the location pointed to by _s_. +The `nng_sub0_open()` function creates a xref:nng_sub.7.adoc[_sub_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_sub0_open_raw()` function creates a <> version 0 -<> in -<> mode and returns it at the location pointed to by _s_. +The `nng_sub0_open_raw()` function creates a xref:nng_sub.7.adoc[_sub_] version 0 +xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -47,7 +47,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_pub.7.adoc[nng_pub(7)], +xref:nng_sub.7.adoc[nng_sub(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_surveyor.7.adoc b/docs/man/nng_surveyor.7.adoc index 19e792af5..c82a6a921 100644 --- a/docs/man/nng_surveyor.7.adoc +++ b/docs/man/nng_surveyor.7.adoc @@ -36,11 +36,11 @@ TIP: This protocol is useful in solving voting problems, such as ((service discovery)) problems. The _surveyor_ protocol is the surveyor side, and the -<> protocol is the respondent side. +xref:nng_respondent.7.adoc[_respondent_] protocol is the respondent side. === Socket Operations -The `<>` +The xref:nng_surveyor_open.3.adoc[`nng_surveyor0_open()`] functions create a surveyor socket. This socket may be used to send messages (surveys), and then to receive replies. A reply can only be received after sending a survey. @@ -57,12 +57,12 @@ Only one survey can be outstanding at a time; sending another survey will cancel the prior one, and any responses from respondents from the prior survey that arrive after this will be discarded. -<> mode sockets ignore all these restrictions. +xref:nng.7.adoc#raw_mode[Raw] mode sockets ignore all these restrictions. === Context Operations -This protocol supports the creation of <> for concurrent -use cases using `<>`. +This protocol supports the creation of xref:nng_ctx.5.adoc[contexts] for concurrent +use cases using xref:nng_ctx_open.3.adoc[`nng_ctx_open()`]. Each context can initiate its own surveys, and it will receive only responses to its own outstanding surveys. @@ -94,7 +94,7 @@ The following protocol-specific options is available. ((`NNG_OPT_SURVEYOR_SURVEYTIME`)):: - (`<>`) Duration of surveys. + (xref:nng_duration.5.adoc[`nng_duration`]) Duration of surveys. 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 @@ -114,7 +114,7 @@ These will be distinguishable from the survey ID by having their most significant bit clear. When a survey message is received by a forwarding node (see -`<>`), the forwarding node prepends a +xref:nng_device.3.adoc[`nng_device()`]), the forwarding node prepends a 32-bit peer ID (which *must* have the most significant bit clear), which is the forwarder's way of identifying the directly connected peer from which it received the message. @@ -137,11 +137,13 @@ When the response finally arrives back at the initiating surveyor, it should have only a single element in the message, which will be the survey ID it originally used for the request. +More detail can be found in the https://github.com/nanomsg/nanomsg/blob/master/rfc/sp-surveyor-01.txt[RFC sp-surveyor-01] +document. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_surveyor_open.3.adoc[nng_surveyor_open(3)], +xref:nng_respondent.7.adoc[nng_respondent(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_surveyor_open.3.adoc b/docs/man/nng_surveyor_open.3.adoc index f2b357b34..cd648f655 100644 --- a/docs/man/nng_surveyor_open.3.adoc +++ b/docs/man/nng_surveyor_open.3.adoc @@ -27,13 +27,13 @@ int nng_surveyor0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_surveyor0_open()` function creates a <> -version 0 <> and returns it at the location +The `nng_surveyor0_open()` function creates a xref:nng_surveyor.7.adoc[_surveyor_] +version 0 xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_surveyor0_open_raw()` function creates a <> -version 0 <> in -<> mode and returns it at the location pointed to by _s_. +The `nng_surveyor0_open_raw()` function creates a xref:nng_surveyor.7.adoc[_surveyor_] +version 0 xref:nng_socket.5.adoc[socket] in +xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_. == RETURN VALUES @@ -48,7 +48,7 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_respondent.7.adoc[nng_respondent(7)], +xref:nng_surveyor.7.adoc[nng_surveyor(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tcp.5.adoc b/docs/man/nng_tcp.5.adoc index 12cb83997..6f4242391 100644 --- a/docs/man/nng_tcp.5.adoc +++ b/docs/man/nng_tcp.5.adoc @@ -31,54 +31,54 @@ TCP stream objects can be used to send or receive data. NOTE: The `nng_tcp` object is used for raw TCP connections, and should not be confused with a pipe object created using the -<> transport. +xref:nng_tcp.7.adoc[nng_tcp(7)] transport. TIP: Most NNG applications should not use this, but instead use the -<> transport instead. +xref:nng_tcp.7.adoc[nng_tcp(7)] transport instead. These objects are created either establishing an outgoing connection -with <> or by +with xref:nng_tcp_dialer_dial.3tcp.adoc[`nng_tcp_dialer_dial()`] or by accepting in incoming connection with -<>. +xref:nng_tcp_listener_accept.3tcp.adoc[`nng_tcp_listener_accept()`]. TCP connections are byte streams, and are "`reliable`" in that data will not be delivered out of order, or with portions missing. -Data can be sent using <> or -received with <>. +Data can be sent using xref:nng_tcp_send.3tcp.adoc[`nng_tcp_send()`] or +received with xref:nng_tcp_recv.3tcp.adoc[`nng_tcp_recv()`]. When the connection is no longer needed, it should be freed with -<>. +xref:nng_tcp_free.3tcp.adoc[`nng_tcp_free()`]. TIP: It is possible to close the connection, without freeing it, by -using <>. +using xref:nng_tcp_close.3tcp.adoc[`nng_tcp_close()`]. === Options The following options are applicable to TCP connections, and may be -accessed using the <> and -<> functions. +accessed using the xref:nng_tcp_getopt.3tcp.adoc[`nng_tcp_getopt()`] and +xref:nng_tcp_setopt.3tcp.adoc[`nng_tcp_setopt()`] functions. -* <> -* <> -* <> -* <> -* <> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NO_DELAY[`NNG_OPT_TCP_NODELAY`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_BOUND_PORT[`NNG_OPT_TCP_BOUND_PORT`] Other platform specific options may be available as well. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_tcp_close.3tcp.adoc[nng_tcp_close(3tcp)], +xref:nng_tcp_dialer_dial.3tcp.adoc[nng_tcp_dialer_dial(3tcp)], +xref:nng_tcp_free.3tcp.adoc[nng_tcp_free(3tcp)], +xref:nng_tcp_getopt.3tcp.adoc[nng_tcp_getopt(3tcp)], +xref:nng_tcp_listener_accept.3tcp.adoc[nng_tcp_listener_accept(3tcp)], +xref:nng_tcp_recv.3tcp.adoc[nng_tcp_recv(3tcp)], +xref:nng_tcp_send.3tcp.adoc[nng_tcp_send(3tcp)], +xref:nng_tcp_setopt.3tcp.adoc[nng_tcp_setopt(3tcp)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_tcp_options.5.adoc[nng_tcp_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tcp.7.adoc b/docs/man/nng_tcp.7.adoc index 6091609b1..3f912a296 100644 --- a/docs/man/nng_tcp.7.adoc +++ b/docs/man/nng_tcp.7.adoc @@ -82,29 +82,29 @@ The entire URI must be less than `NNG_MAXADDRLEN` bytes long. === Socket Address -When using an <> structure, +When using an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure, the actual structure is either of type -<> (for IPv4) or -<> (for IPv6). +xref:nng_sockaddr_in.5.adoc[`nng_sockaddr_in`] (for IPv4) or +xref:nng_sockaddr_in6.5.adoc[`nng_sockaddr_in6`] (for IPv6). === Transport Options The following transport options are supported by this transport, where supported by the underlying platform. -* <> -* <> -* <> -* <> -* <> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NODELAY[`NNG_OPT_TCP_NODELAY`] +* xref:nng_options.5.adoc#NNG_OPT_URL[`NNG_OPT_URL`] == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_sockaddr_in.5.adoc[nng_sockaddr_in(5)], +xref:nng_sockaddr_in6.5.adoc[nng_sockaddr_in6(5)], +xref:nng_tcp_options.5.adoc[nng_tcp_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tcp_register.3.adoc b/docs/man/nng_tcp_register.3.adoc index fe199de48..1a3a85817 100644 --- a/docs/man/nng_tcp_register.3.adoc +++ b/docs/man/nng_tcp_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> +xref:nng_tcp.7.adoc[nng_tcp(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_thread_create.3supp.adoc b/docs/man/nng_thread_create.3supp.adoc index 63906b397..0822a963c 100644 --- a/docs/man/nng_thread_create.3supp.adoc +++ b/docs/man/nng_thread_create.3supp.adoc @@ -42,7 +42,7 @@ programs that use simple sequential execution, using functions in the _NNG_ suite that would otherwise normally "`block`". When the thread is no longer needed, the -`<>` +xref:nng_thread_destroy.3supp.adoc[`nng_thread_destroy()`] function should be used to reap it. (This function will block waiting for _func_ to return.) @@ -59,13 +59,13 @@ to any system threading functions. TIP: The system may impose limits on the number of threads that can be created. -Typically applications should not create more than a few dozen of these. +Typically applications should not create more than a dozen of these. If greater concurrency or scalability is needed, consider instead using -an asynchronous model using `<>` structures. +an asynchronous model using xref:nng_aio.5.adoc[`nng_aio`] structures. TIP: Threads can be synchronized using -<> and -<>. +xref:nng_mtx_alloc.3supp.adoc[mutexes] and +xref:nng_cv_alloc.3supp.adoc[condition variables]. == RETURN VALUES @@ -79,9 +79,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_thread_destroy.3supp.adoc[nng_thread_destroy(3supp)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_thread_destroy.3supp.adoc b/docs/man/nng_thread_destroy.3supp.adoc index 788a3495b..95eed8131 100644 --- a/docs/man/nng_thread_destroy.3supp.adoc +++ b/docs/man/nng_thread_destroy.3supp.adoc @@ -43,5 +43,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_thread_create.3supp.adoc[nng_thread_create(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls.5.adoc b/docs/man/nng_tls.5.adoc index 3e10f3150..36395512b 100644 --- a/docs/man/nng_tls.5.adoc +++ b/docs/man/nng_tls.5.adoc @@ -33,54 +33,54 @@ stream. NOTE: The `nng_tls` object is used for raw TLS connections, and should not be confused with a pipe object created using the -<> transport. +xref:nng_tls.7.adoc[nng_tls(7)] transport. TIP: Most NNG applications should not use this, but instead use the -<> transport instead. +xref:nng_tls.7.adoc[nng_tls(7)] transport instead. These objects are created either establishing an outgoing connection -with <> or by +with xref:nng_tls_dialer_dial.3tls.adoc[`nng_tls_dialer_dial()`] or by accepting in incoming connection with -<>. +xref:nng_tls_listener_accept.3tls.adoc[`nng_tls_listener_accept()`]. TLS connections are byte streams, and are "`reliable`" in that data will not be delivered out of order, or with portions missing. -Data can be sent using <> or -received with <>. +Data can be sent using xref:nng_tls_send.3tls.adoc[`nng_tls_send()`] or +received with xref:nng_tls_recv.3tls.adoc[`nng_tls_recv()`]. When the connection is no longer needed, it should be freed with -<>. +xref:nng_tls_free.3tls.adoc[`nng_tls_free()`]. TIP: It is possible to close the connection, without freeing it, by -using <>. +using xref:nng_tls_close.3tls.adoc[`nng_tls_close()`]. === Options The following options are applicable to TLS connections, and may be -accessed using the <> and -<> functions. +accessed using the xref:nng_tls_getopt.3tls.adoc[`nng_tls_getopt()`] and +xref:nng_tls_setopt.3tls.adoc[`nng_tls_setopt()`] functions. -* <> -* <> -* <> -* <> -* <> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NO_DELAY[`NNG_OPT_TCP_NODELAY`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_VERIFIED[`NNG_OPT_TLS_VERIFIED`] Other platform specific options may be available as well. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:libnng.3.adoc[libnng(3)], +xref:nng_tls_close.3tls.adoc[nng_tls_close(3tls)], +xref:nng_tls_dialer_dial.3tls.adoc[nng_tls_dialer_dial(3tls)], +xref:nng_tls_free.3tls.adoc[nng_tls_free(3tls)], +xref:nng_tls_getopt.3tls.adoc[nng_tls_getopt(3tls)], +xref:nng_tls_listener_accept.3tls.adoc[nng_tls_listener_accept(3tls)], +xref:nng_tls_recv.3tls.adoc[nng_tls_recv(3tls)], +xref:nng_tls_send.3tls.adoc[nng_tls_send(3tls)], +xref:nng_tls_setopt.3tls.adoc[nng_tls_setopt(3tls)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_tls_options.5.adoc[nng_tls_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc index f2db7035a..38903fc29 100644 --- a/docs/man/nng_tls.7.adoc +++ b/docs/man/nng_tls.7.adoc @@ -38,7 +38,7 @@ http://nanomsg.org/rfcs/sp-tls-v1.html[TLS Mapping for Scalability Protocols]. Depending upon how the library was built, it may be necessary to register the transport by calling -<>. +xref:nng_tls_register.3.adoc[`nng_tls_register()`]. === Availability @@ -108,35 +108,35 @@ The entire URI must be less than `NNG_MAXADDRLEN` bytes long. === Socket Address -When using an <> structure, +When using an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure, the actual structure is either of type -<> (for IPv4) or -<> (for IPv6). +xref:nng_sockaddr_in.5.adoc[`nng_sockaddr_in`] (for IPv4) or +xref:nng_sockaddr_in6.5.adoc[`nng_sockaddr_in6`] (for IPv6). === Transport Options The following transport options are available. Note that setting these must be done before the transport is started. -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NODELAY[`NNG_OPT_TCP_NODELAY`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_AUTH_MODE[`NNG_OPT_TLS_AUTH_MODE`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_CA_FILE[`NNG_OPT_TLS_CA_FILE`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_CERT_KEY_FILE[`NNG_OPT_TLS_CERT_KEY_FILE`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_CONFIG[`NNG_OPT_TLS_CONFIG`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_VERIFIED[`NNG_OPT_TLS_VERIFIED_`] +* xref:nng_options.5.adoc#NNG_OPT_URL[`NNG_OPT_URL`] == SEE ALSO [.text-left] -<> -<>, -<>, -<>, -<>, -<>, -<>, -<>, +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)] +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_sockaddr_in.5.adoc[nng_sockaddr_in(5)], +xref:nng_sockaddr_in6.5.adoc[nng_sockaddr_in6(5)], +xref:nng_tcp_options.5.adoc[nng_tcp_options(5)], +xref:nng_tls_config.5.adoc[nng_tls_config(5)], +xref:nng_tls_options.5.adoc[nng_tls_options(5)], +xref:nng.7.adoc[nng(7)], diff --git a/docs/man/nng_tls_config.5.adoc b/docs/man/nng_tls_config.5.adoc index ad88e9eb0..8d3fee590 100644 --- a/docs/man/nng_tls_config.5.adoc +++ b/docs/man/nng_tls_config.5.adoc @@ -38,20 +38,20 @@ However once a configuration is used, it enters a read-only state that precludes further modifications to the configuration. Messages are allocated using the -<> +xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`] function, and are deallocated using the -<> +xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`] function. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_auth_mode.3tls.adoc[nng_tls_config_auth_mode(3tls)], +xref:nng_tls_config_ca_chain.3tls.adoc[nng_tls_config_ca_chain(3tls)], +xref:nng_tls_config_own_cert.3tls.adoc[nng_tls_config_own_cert(3tls)], +xref:nng_tls_config_free.3tls.adoc[nng_tls_config_free(3tls)], +xref:nng_tls_config_hold.3tls.adoc[nng_tls_config_hold(3tls)], +xref:nng_tls_config_server_name.3tls.adoc[nng_tls_config_server_name(3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_alloc.3tls.adoc b/docs/man/nng_tls_config_alloc.3tls.adoc index 9b218d9d7..7af515869 100644 --- a/docs/man/nng_tls_config_alloc.3tls.adoc +++ b/docs/man/nng_tls_config_alloc.3tls.adoc @@ -50,9 +50,9 @@ that object is not inadvertently freed while in use. A configuration object created with `nng_tls_config_alloc()` starts with a reference count of one. The reference count may be incremented using -<> and may be +xref:nng_tls_config_hold.3tls.adoc[`nng_tls_config_hold()`] and may be decremented with -<>. +xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`]. Also note that a TLS configuration object becomes "`read-only`" after it is first used with a service. @@ -73,12 +73,12 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_auth_mode.3tls.adoc[nng_tls_config_auth_mode(3tls)], +xref:nng_tls_config_ca_chain.3tls.adoc[nng_tls_config_ca_chain(3tls)], +xref:nng_tls_config_own_cert.3tls.adoc[nng_tls_config_own_cert(3tls)], +xref:nng_tls_config_free.3tls.adoc[nng_tls_config_free(3tls)], +xref:nng_tls_config_hold.3tls.adoc[nng_tls_config_hold(3tls)], +xref:nng_tls_config_server_name.3tls.adoc[nng_tls_config_server_name(3tls)], +xref:nng_tls_config.5.adoc[nng_tls_config(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_auth_mode.3tls.adoc b/docs/man/nng_tls_config_auth_mode.3tls.adoc index 958faf020..875986236 100644 --- a/docs/man/nng_tls_config_auth_mode.3tls.adoc +++ b/docs/man/nng_tls_config_auth_mode.3tls.adoc @@ -67,9 +67,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_ca_chain.3tls.adoc[nng_tls_config_ca_chain(3tls)], +xref:nng_tls_config_ca_file.3tls.adoc[nng_tls_config_ca_file(3tls)], +xref:nng_tls_config_server_name.3tls.adoc[nng_tls_config_server_name(3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_ca_chain.3tls.adoc b/docs/man/nng_tls_config_ca_chain.3tls.adoc index 52e2c1c31..3a96e1a62 100644 --- a/docs/man/nng_tls_config_ca_chain.3tls.adoc +++ b/docs/man/nng_tls_config_ca_chain.3tls.adoc @@ -57,8 +57,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(.3tls)], +xref:nng_tls_config_auth_mode.3tls.adoc[nng_tls_config_auth_mode(.3tls)], +xref:nng_tls_config_ca_file.3tls.adoc[nng_tls_config_ca_file(.3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_ca_file.3tls.adoc b/docs/man/nng_tls_config_ca_file.3tls.adoc index 2743425c5..66bf58ee1 100644 --- a/docs/man/nng_tls_config_ca_file.3tls.adoc +++ b/docs/man/nng_tls_config_ca_file.3tls.adoc @@ -57,8 +57,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_auth_mode.3tls.adoc[nng_tls_config_auth_mode(3tls)], +xref:nng_tls_config_ca_chain.3tls.adoc[nng_tls_config_ca_chain(3tls)], +xref:nng.7.adoc[nng(7)] 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 802b050e9..9b7473e9b 100644 --- a/docs/man/nng_tls_config_cert_key_file.3tls.adoc +++ b/docs/man/nng_tls_config_cert_key_file.3tls.adoc @@ -62,7 +62,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_own_cert.3tls.adoc[nng_tls_config_own_cert(3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_free.3tls.adoc b/docs/man/nng_tls_config_free.3tls.adoc index 41e1b8b83..c51502d41 100644 --- a/docs/man/nng_tls_config_free.3tls.adoc +++ b/docs/man/nng_tls_config_free.3tls.adoc @@ -40,5 +40,5 @@ None. == SEE ALSO [.text-left] -<>, -<> +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_hold.3tls.adoc b/docs/man/nng_tls_config_hold.3tls.adoc index 5fa83ac8f..8f97ef82e 100644 --- a/docs/man/nng_tls_config_hold.3tls.adoc +++ b/docs/man/nng_tls_config_hold.3tls.adoc @@ -29,7 +29,7 @@ the configuration object named by _cfg_, thereby preventing it from being freed while in use. The hold can be released by calling -<>. +xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`]. Multiple holds can be placed on a configuration object; the object will not be freed until the last hold is released. @@ -45,6 +45,6 @@ None. == SEE ALSO [.text-left] -<>, -<>, -<> +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_free.3tls.adoc[nng_tls_config_free(3tls)], +xref:nng.7.adoc[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 789ae9d39..c7215d450 100644 --- a/docs/man/nng_tls_config_own_cert.3tls.adoc +++ b/docs/man/nng_tls_config_own_cert.3tls.adoc @@ -61,7 +61,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_cert_key_file.3tls.adoc[nng_tls_config_cert_key_file(3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_config_server_name.3tls.adoc b/docs/man/nng_tls_config_server_name.3tls.adoc index 1620f770c..70fe12d6b 100644 --- a/docs/man/nng_tls_config_server_name.3tls.adoc +++ b/docs/man/nng_tls_config_server_name.3tls.adoc @@ -48,7 +48,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<> +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_tls_config_auth_mode.3tls.adoc[nng_tls_config_auth_mode(3tls)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_options.5.adoc b/docs/man/nng_tls_options.5.adoc index 0a30daa26..91df9d31c 100644 --- a/docs/man/nng_tls_options.5.adoc +++ b/docs/man/nng_tls_options.5.adoc @@ -48,31 +48,31 @@ description of the option. [[NNG_OPT_TLS_AUTH_MODE]]((`NNG_OPT_TLS_AUTH_MODE`)):: (`int`) Write-only option used to configure the authentication mode used. -See <> for +See xref:nng_tls_config_auth_mode.3tls.adoc[`nng_tls_config_auth_mode()`] for more details. [[NNG_OPT_TLS_CA_FILE]]((`NNG_OPT_TLS_CA_FILE`)):: (string) Write-only option naming a file containing certificates to use for peer validation. -See <> for more +See xref:nng_tls_config_ca_file.3tls.adoc[`nng_tls_config_ca_file()`] for more information. [[NNG_OPT_TLS_CERT_KEY_FILE]]((`NNG_OPT_TLS_CERT_KEY_FILE`)):: (string) Write-only option naming a file containing the local certificate and associated private key. The private key used must be unencrypted. -See <> for more +See xref:nng_tls_config_own_cert.3tls.adoc[`nng_tls_config_own_cert()`] for more information. [[NNG_OPT_TLS_CONFIG]]((`NNG_OPT_TLS_CONFIG`)):: (`nng_tls_config *`) This option references the underlying -<>. +xref:nng_tls_config.5.adoc[TLS configuration object]. A hold is placed on the underlying configuration object before returning it. + NOTE: The caller should release the hold with -<> when it no +xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`] when it no longer needs the TLS configuration object. + TIP: Use this option when more advanced TLS configuration is required. @@ -96,21 +96,21 @@ May return incorrect results if peer authentication is disabled. Generally, the following option values are also available for TLS objects, when appropriate for the context: -* <> -* <> -* <> -* <> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NODELAY[`NNG_OPT_TCP_NODELAY`] == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> -<> -<>, -<> +xref:nng_tls_dialer_getopt.3tls.adoc[nng_tls_dialer_getopt(3tls)], +xref:nng_tls_dialer_setopt.3tls.adoc[nng_tls_dialer_setopt(3tls)], +xref:nng_tls_getopt.3tls.adoc[nng_tls_getopt(3tls)], +xref:nng_tls_listener_getopt.3tls.adoc[nng_tls_listener_getopt(3tls)], +xref:nng_tls_listener_setopt.3tls.adoc[nng_tls_listener_setopt(3tls)], +xref:nng_tls_setopt.3tls.adoc[nng_tls_setopt(3tls)], +xref:nng_options.5.adoc[nng_options(5)] +xref:nng_tcp_options.5.adoc[nng_tcp_options(5)] +xref:nng_tls_config.5.adoc[nng_tls_config(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls_register.3.adoc b/docs/man/nng_tls_register.3.adoc index a01388ebf..17788ae22 100644 --- a/docs/man/nng_tls_register.3.adoc +++ b/docs/man/nng_tls_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<> +xref:nng_tls.7.adoc[nng_tls(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc index 1895eaf19..ef446e327 100644 --- a/docs/man/nng_ws.7.adoc +++ b/docs/man/nng_ws.7.adoc @@ -37,11 +37,11 @@ http://nanomsg.org/rfcs/sp-websocket-v1.html[WebSocket Mapping for Scalability P === Registration Depending upon how the library was built, it may be necessary to -register the transport by calling <>. +register the transport by calling xref:nng_ws_register.3.adoc[`nng_ws_register()`]. 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 <> function. +the xref:nng_wss_register.3.adoc[`nng_wss_register()`] function. === URI Format @@ -77,10 +77,10 @@ permitted, with IPv4 addresses mapped to IPv6 addresses.) === Socket Address -When using an <> structure, +When using an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure, the actual structure is either of type -<> (for IPv4) or -<> (for IPv6). +xref:nng_sockaddr_in.5.adoc[`nng_sockaddr_in`] (for IPv4) or +xref:nng_sockaddr_in6.5.adoc[`nng_sockaddr_in6`] (for IPv6). === Server Instances @@ -133,7 +133,7 @@ configuration object for `wss://` endpoints. A hold is placed on the underlying configuration object before returning it. The caller should release the object with -<> when it no +xref:nng_tls_config_free.3tls.adoc[`nng_tls_config_free()`] when it no longer needs the TLS configuration. TIP: Use this option when advanced TLS configuration is required. @@ -141,19 +141,19 @@ TIP: Use this option when advanced TLS configuration is required. ((`NNG_OPT_TLS_CA_FILE`)):: (string) Write-only option naming a file containing certificates to use for peer validation. -See <> for more +See xref:nng_tls_config_ca_file.3tls.adoc[`nng_tls_config_ca_file()`] for more information. ((`NNG_OPT_TLS_CERT_KEY_FILE`)):: (string) Write-only option naming a file containing the local certificate and associated private key. The private key used must be unencrypted. -See <> for more +See xref:nng_tls_config_own_cert.3tls.adoc[`nng_tls_config_own_cert()`] for more information. ((`NNG_OPT_TLS_AUTH_MODE`)):: (`int`) Write-only option used to configure the authentication mode used. -See <> for +See xref:nng_tls_config_auth_mode.3tls.adoc[`nng_tls_config_auth_mode()`] for more details. `NNG_OPT_TLS_VERIFIED`:: @@ -170,8 +170,8 @@ May return incorrect results if peer authentication is disabled. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<> +xref:nng_tls_config_alloc.3tls.adoc[nng_tls_config_alloc(3tls)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng_sockaddr_in.5.adoc[nng_sockaddr_in(5)], +xref:nng_sockaddr_in6.5.adoc[nng_sockaddr_in6(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index e7a9f1080..31988079d 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -60,7 +60,7 @@ concepts and administration. Depending upon how the library was built, it may be necessary to register the transport by calling -`<>`. +xref:nng_zt_register.3.adoc[`nng_zt_register()`]. This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason. @@ -82,13 +82,13 @@ the node's own node number. Listeners may use port 0 to indicate that a suitable port number be selected automatically. Applications using this must determine the selected port number using the -`<>` function. +xref:nng_listener_getopt.3.adoc[`nng_listener_getopt()`] function. === Socket Address -When using an `<>` structure, +When using an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure, the actual structure is of type -`<>`. +xref:nng_sockaddr_zt.5.adoc[`nng_sockaddr_zt`]. === Node Presence @@ -172,7 +172,7 @@ in this fashion. [[NNG_OPT_ZT_CONN_TIME]] ((`NNG_OPT_ZT_CONN_TIME`)):: - (`<>`) + (xref:nng_duration.5.adoc[`nng_duration`]) The time to wait between sending connection attempts, only used with dialers. The default is 500 msec. @@ -187,7 +187,7 @@ in this fashion. [[NNG_OPT_ZT_PING_TIME]] ((`NNG_OPT_ZT_PING_TIME`)):: - (`<>`) If no traffic has been received from + (xref:nng_duration.5.adoc[`nng_duration`]) If no traffic has been received from the ZeroTier peer after this period of time, then a "`ping`" message is sent to check if the peer is still alive. @@ -222,5 +222,5 @@ in this fashion. == SEE ALSO [.text-left] -<>, -<> +xref:nng_sockaddr_zt.5.adoc[nng_sockaddr_zt(5)], +xref:nng.7.adoc[nng(7)]