diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-06-29 17:26:04 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-06-29 17:26:04 -0700 |
| commit | 7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (patch) | |
| tree | 7b78decbdc3bbdfac1b80d13a145aa640f2a7504 /docs/man | |
| parent | 3e8522a8c766deeb97158cdeb2cd35470063f35f (diff) | |
| download | nng-7b6e73f23104a50b898da1065cf9d3bf8b6a3bca.tar.gz nng-7b6e73f23104a50b898da1065cf9d3bf8b6a3bca.tar.bz2 nng-7b6e73f23104a50b898da1065cf9d3bf8b6a3bca.zip | |
more .adoc markup fixes.
This is mostly mechanical-ish fixups to adjust markup style
for cross references. A bit of care and feeding needed, so
we haven't finished the list, but this gets a significant chunk
of them.
Diffstat (limited to 'docs/man')
70 files changed, 664 insertions, 664 deletions
diff --git a/docs/man/nng_aio.5.adoc b/docs/man/nng_aio.5.adoc index db0860e3..13cc49fc 100644 --- a/docs/man/nng_aio.5.adoc +++ b/docs/man/nng_aio.5.adoc @@ -37,34 +37,34 @@ This callback will be executed exactly once. The asynchronous I/O framework in _nng_ also supports cancellation of operations that are already in progress -(see `<<nng_aio_cancel.3#,nng_aio_cancel()>>`), as well setting a maximum +(see xref:nng_aio_cancel.3.adoc[`nng_aio_cancel()`]), as well setting a maximum timeout for them to complete within -(see `<<nng_aio_set_timeout.3#,nng_aio_set_timeout()>>`). +(see xref:nng_aio_set_timeout.3.adoc[`nng_aio_set_timeout()`]). It is also possible to initiate an asynchronous operation, and wait for it to -complete using `<<nng_aio_wait.3#,nng_aio_wait()>>`. +complete using xref:nng_aio_wait.3.adoc[`nng_aio_wait()`]. -These structures are created using the `<<nng_aio_alloc.3#,nng_aio_alloc()>>`, -and destroyed using `<<nng_aio_free.3#,nng_aio_free()>>`. +These structures are created using the xref:nng_aio_alloc.3.adoc[`nng_aio_alloc()`], +and destroyed using xref:nng_aio_free.3.adoc[`nng_aio_free()`]. == SEE ALSO [.text-left] -<<nng_aio_abort.3#,nng_aio_abort(3)>>, -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_count.3#,nng_aio_count(3)>>, -<<nng_aio_free.3#,nng_aio_free(3)>>, -<<nng_aio_get_input.3#,nng_aio_get_input(3)>>, -<<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio_set_input.3#,nng_aio_set_input(3)>>, -<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>, -<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, -<<nng_aio_set_timeout.3#,nng_aio_set_timeout(3)>>, -<<nng_aio_stop.3#,nng_aio_stop(3)>>, -<<nng_aio_wait.3#,nng_aio_wait(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_free.3.adoc[nng_aio_free(3)], +xref:nng_aio_get_input.3.adoc[nng_aio_get_input(3)], +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_aio_set_timeout.3.adoc[nng_aio_set_timeout(3)], +xref:nng_aio_stop.3.adoc[nng_aio_stop(3)], +xref:nng_aio_wait.3.adoc[nng_aio_wait(3)], +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_aio_abort.3.adoc b/docs/man/nng_aio_abort.3.adoc index d48e9973..8d4e904b 100644 --- a/docs/man/nng_aio_abort.3.adoc +++ b/docs/man/nng_aio_abort.3.adoc @@ -28,7 +28,7 @@ The `nng_aio_abort()` function aborts an operation previously started with the handle _aio_. If the operation is aborted, then the callback for the handle will be called, and the function -`<<nng_aio_result.3#,nng_aio_result()>>` will return the error _err_. +xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return the error _err_. This function does not wait for the operation to be fully aborted, but returns immediately. @@ -48,8 +48,8 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_alloc.3.adoc b/docs/man/nng_aio_alloc.3.adoc index 056705c8..66e53457 100644 --- a/docs/man/nng_aio_alloc.3.adoc +++ b/docs/man/nng_aio_alloc.3.adoc @@ -34,22 +34,22 @@ NOTE: The callback _callb_ must not perform any blocking operations, and must complete its execution quickly. If _callb_ does block, this can lead ultimately to an apparent "hang" or deadlock in the application. -Asynchronous I/O operations all take an `<<nng_aio.5#,nng_aio>>` +Asynchronous I/O operations all take an xref:nng_aio.5.adoc[`nng_aio`] handle such as allocated by this function. Such operations are usually started by a function that returns immediately. The operation is then run asynchronously, and completes sometime later. When that operation is complete, the callback supplied here is called, and that callback is able to determine the result of the operation using -`<<nng_aio_result.3#,nng_aio_result()>>`, -`<<nng_aio_count.3#,nng_aio_count()>>`, -and `<<nng_aio_get_output.3#,nng_aio_get_output()>>`. +xref:nng_aio_result.3.adoc[`nng_aio_result()`], +xref:nng_aio_count.3.adoc[`nng_aio_count()`], +and xref:nng_aio_get_output.3.adoc[`nng_aio_get_output()`]. It is possible to wait synchronously for an otherwise asynchronous operation -by using the function `<<nng_aio_wait.3#,nng_aio_wait()>>`. +by using the function xref:nng_aio_wait.3.adoc[`nng_aio_wait()`]. In that case, it is permissible for _callb_ and _arg_ to both be `NULL`. Note that if these are `NULL`, then it will not be possible to determine when the operation is complete except by calling the aforementioned -`<<nng_aio_wait.3#,nng_aio_wait()>>`. +xref:nng_aio_wait.3.adoc[`nng_aio_wait()`]. == RETURN VALUES @@ -63,20 +63,20 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_aio_abort.3#,nng_aio_abort(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_count.3#,nng_aio_count(3)>>, -<<nng_aio_free.3#,nng_aio_free(3)>>, -<<nng_aio_get_input.3#,nng_aio_get_input(3)>>, -<<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio_set_input.3#,nng_aio_set_input(3)>>, -<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>, -<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, -<<nng_aio_set_timeout.3#,nng_aio_set_timeout(3)>>, -<<nng_aio_stop.3#,nng_aio_stop(3)>>, -<<nng_aio_wait.3#,nng_aio_wait(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_free.3.adoc[nng_aio_free(3)], +xref:nng_aio_get_input.3.adoc[nng_aio_get_input(3)], +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_aio_set_timeout.3.adoc[nng_aio_set_timeout(3)], +xref:nng_aio_stop.3.adoc[nng_aio_stop(3)], +xref:nng_aio_wait.3.adoc[nng_aio_wait(3)], +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_aio_begin.3.adoc b/docs/man/nng_aio_begin.3.adoc index 5ea2a3e3..30a73648 100644 --- a/docs/man/nng_aio_begin.3.adoc +++ b/docs/man/nng_aio_begin.3.adoc @@ -35,7 +35,7 @@ This operation should be called at the start of any I/O operation, and must be called not more than once for a given I/O operation on a given _aio_. Once this function is called, if `true` is returned, then the provider MUST -guarantee that `<<nng_aio_finish.3#,nng_aio_finish()>>` is called for the _aio_ +guarantee that xref:nng_aio_finish.3.adoc[`nng_aio_finish()`] is called for the _aio_ exactly once, when the operation is complete or canceled. NOTE: This function is only for I/O providers (those actually performing @@ -55,10 +55,10 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_defer.3#,nng_aio_defer(3)>>, -<<nng_aio_finish.3#,nng_aio_finish(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_defer.3.adoc[nng_aio_defer(3)], +xref:nng_aio_finish.3.adoc[nng_aio_finish(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_cancel.3.adoc b/docs/man/nng_aio_cancel.3.adoc index 9d646110..3b32c827 100644 --- a/docs/man/nng_aio_cancel.3.adoc +++ b/docs/man/nng_aio_cancel.3.adoc @@ -28,7 +28,7 @@ The `nng_aio_cancel()` function aborts an operation previously started with the handle _aio_. If the operation is aborted, then the callback for the handle will be called, and the function -`<<nng_aio_result.3#,nng_aio_result()>>` will return the error `NNG_ECANCELED`. +xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return the error `NNG_ECANCELED`. This function does not wait for the operation to be fully aborted, but returns immediately. @@ -38,7 +38,7 @@ finished, or no operation has been started yet), then this function has no effect. NOTE: This function is the same as calling -`<<nng_aio_abort.3#,nng_aio_abort()>>` with the error `NNG_ECANCELED`. +xref:nng_aio_abort.3.adoc[`nng_aio_abort()`] with the error `NNG_ECANCELED`. == RETURN VALUES @@ -51,8 +51,8 @@ None. == SEE ALSO [.text-left] -<<nng_aio_abort.3#,nng_aio_abort(3)>>, -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_count.3.adoc b/docs/man/nng_aio_count.3.adoc index 43ca6907..daf97710 100644 --- a/docs/man/nng_aio_count.3.adoc +++ b/docs/man/nng_aio_count.3.adoc @@ -33,13 +33,13 @@ transfer user data (they may transfer protocol data though) -- in this case this function will generally return zero. This function is most useful when used with operations that make use of -of a scatter/gather vector (set by `<<nng_aio_set_iov.3#,nng_aio_set_iov()>>`). +of a scatter/gather vector (set by xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`]). NOTE: The return value from this function is undefined if the operation has not completed yet. Either call this from the handle's completion callback, or after waiting for the operation to complete with -`<<nng_aio_wait.3#,nng_aio_wait()>>`. +xref:nng_aio_wait.3.adoc[`nng_aio_wait()`]. == RETURN VALUES @@ -52,10 +52,10 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>, -<<nng_aio_wait.3#,nng_aio_wait(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(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_aio_wait.3.adoc[nng_aio_wait(3)], +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_aio_defer.3.adoc b/docs/man/nng_aio_defer.3.adoc index 67520293..5664a6df 100644 --- a/docs/man/nng_aio_defer.3.adoc +++ b/docs/man/nng_aio_defer.3.adoc @@ -40,11 +40,11 @@ completed, or be in a state where it is no longer possible to unschedule it. In this case, the _cancelfn_ should just return without making any changes. If the cancellation routine successfully canceled the operation, it should -ensure that `<<nng_aio_finish.3#,nng_aio_finish()>>` is called, with the +ensure that xref:nng_aio_finish.3.adoc[`nng_aio_finish()`] is called, with the error code specified by _err_. IMPORTANT: It is mandatory that I/O providers call -`<<nng_aio_finish.3#,nng_aio_finish()>>` +xref:nng_aio_finish.3.adoc[`nng_aio_finish()`] *EXACTLY ONCE* when they are finished with the operation. NOTE: This function is only for I/O providers (those actually performing @@ -70,9 +70,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_finish.3#,nng_aio_finish(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_finish.3.adoc[nng_aio_finish(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_finish.3.adoc b/docs/man/nng_aio_finish.3.adoc index 4733c1f2..f4c6edac 100644 --- a/docs/man/nng_aio_finish.3.adoc +++ b/docs/man/nng_aio_finish.3.adoc @@ -27,7 +27,7 @@ void nng_aio_finish(nng_aio *aio, int err); The `nng_aio_finish()` function marks operation associated with _aio_ as complete, with the status _err_. This will be the result returned by -`<<nng_aio_result.3#,nng_aio_result()>>`. +xref:nng_aio_result.3.adoc[`nng_aio_result()`]. This function causes the callback associated with the _aio_ to called. @@ -51,10 +51,10 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_begin.3#,nng_aio_begin(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_defer.3#,nng_aio_defer(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_begin.3.adoc[nng_aio_begin(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_defer.3.adoc[nng_aio_defer(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_free.3.adoc b/docs/man/nng_aio_free.3.adoc index da45eff2..31c75414 100644 --- a/docs/man/nng_aio_free.3.adoc +++ b/docs/man/nng_aio_free.3.adoc @@ -28,7 +28,7 @@ The `nng_aio_free()` function frees an allocated asynchronous I/O handle. If any operation is in progress, the operation is canceled, and the caller is blocked until the operation is completely canceled, to ensure that it is safe to deallocate the handle and any associated resources. -(This is done by implicitly calling `<<nng_aio_stop.3#,nng_aio_stop()>>`.) +(This is done by implicitly calling xref:nng_aio_stop.3.adoc[`nng_aio_stop()`].) == RETURN VALUES @@ -41,7 +41,7 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_stop.3#,nng_aio_stop(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_stop.3.adoc[nng_aio_stop(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_get_input.3.adoc b/docs/man/nng_aio_get_input.3.adoc index 133e7ea1..204ec435 100644 --- a/docs/man/nng_aio_get_input.3.adoc +++ b/docs/man/nng_aio_get_input.3.adoc @@ -26,7 +26,7 @@ void *nng_aio_get_input(nng_aio *aio, unsigned int index); The `nng_aio_get_input()` function returns the value of the input parameter previously set at _index_ on _aio_ with the -`<<nng_aio_set_input.3#,nng_aio_set_input()>>` function. +xref:nng_aio_set_input.3.adoc[`nng_aio_set_input()`] function. The valid values of _index_ range from zero (0) to three (3), as no operation currently defined can accept more than four parameters. @@ -45,9 +45,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_set_input.3#,nng_aio_set_input(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_get_msg.3.adoc b/docs/man/nng_aio_get_msg.3.adoc index a9e8f4b2..c4205658 100644 --- a/docs/man/nng_aio_get_msg.3.adoc +++ b/docs/man/nng_aio_get_msg.3.adoc @@ -26,10 +26,10 @@ nng_msg *nng_aio_get_msg(nng_aio *aio); The `nng_aio_get_msg()` function gets any message stored in _aio_ as either a result of a successful receive -(see `<<nng_recv_aio.3#,nng_recv_aio()>>`) -or that was previously stored with `<<nng_aio_set_msg.3#,nng_aio_set_msg()>>`. +(see xref:nng_recv_aio.3.adoc[`nng_recv_aio()`]) +or that was previously stored with xref:nng_aio_set_msg.3.adoc[`nng_aio_set_msg()`]. -IMPORTANT: The `<<nng_aio.5#,nng_aio>>` must not have an operation in progress. +IMPORTANT: The xref:nng_aio.5.adoc[`nng_aio`] must not have an operation in progress. == RETURN VALUES @@ -42,8 +42,8 @@ None. == SEE ALSO [.text-left] -<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, -<<nng_recv_aio.3#,nng_recv_aio(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_msg.5#,nng_msg(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_recv_aio.3.adoc[nng_recv_aio(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_get_output.3.adoc b/docs/man/nng_aio_get_output.3.adoc index 862b2945..4dfd67c3 100644 --- a/docs/man/nng_aio_get_output.3.adoc +++ b/docs/man/nng_aio_get_output.3.adoc @@ -48,9 +48,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_set_input.3#,nng_aio_set_input(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_result.3.adoc b/docs/man/nng_aio_result.3.adoc index 01a8d3d5..e1886a6e 100644 --- a/docs/man/nng_aio_result.3.adoc +++ b/docs/man/nng_aio_result.3.adoc @@ -33,7 +33,7 @@ NOTE: The return value from this function is undefined if the operation has not completed yet. Either call this from the handle's completion callback, or after waiting for the operation to complete with -`<<nng_aio_wait.3#,nng_aio_wait()>>`. +xref:nng_aio_wait.3.adoc[`nng_aio_wait()`]. == RETURN VALUES @@ -51,9 +51,9 @@ Various other return values are possible depending on the operation. == SEE ALSO [.text-left] -<<nng_aio_abort.3#,nng_aio_abort(3)>>, -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_wait.3#,nng_aio_wait(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_wait.3.adoc[nng_aio_wait(3)], +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_aio_set_input.3.adoc b/docs/man/nng_aio_set_input.3.adoc index ed635249..37cf3cdd 100644 --- a/docs/man/nng_aio_set_input.3.adoc +++ b/docs/man/nng_aio_set_input.3.adoc @@ -42,7 +42,7 @@ IMPORTANT: It is an error to call this function while the _aio_ is currently in use by an active asynchronous operation. An input parameter set with this function may be retrieved later with -the `<<nng_aio_get_input.3#,nng_aio_get_input()>>` function. +the xref:nng_aio_get_input.3.adoc[`nng_aio_get_input()`] function. == RETURN VALUES @@ -55,9 +55,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_get_input.3#,nng_aio_get_input(3)>>, -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_get_input.3.adoc[nng_aio_get_input(3)], +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_set_iov.3.adoc b/docs/man/nng_aio_set_iov.3.adoc index 72f3fdf3..8d720c1d 100644 --- a/docs/man/nng_aio_set_iov.3.adoc +++ b/docs/man/nng_aio_set_iov.3.adoc @@ -27,7 +27,7 @@ int nng_aio_set_iov(nng_aio *aio, unsigned int niov, nng_iov *iov); The `nng_aio_set_iov()` function sets a ((scatter/gather)) vector _iov_ on the handle _aio_. -The _iov_ is a pointer to an array of _niov_ `<<nng_iov.5#,nng_iov>>` +The _iov_ is a pointer to an array of _niov_ xref:nng_iov.5.adoc[`nng_iov`] structures, which have the following definition: [source, c] @@ -67,10 +67,10 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_count.3#,nng_aio_count(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_iov.5#,nng_iov(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_iov.5.adoc[nng_iov(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_set_msg.3.adoc b/docs/man/nng_aio_set_msg.3.adoc index 13702c15..e0ea3e46 100644 --- a/docs/man/nng_aio_set_msg.3.adoc +++ b/docs/man/nng_aio_set_msg.3.adoc @@ -25,9 +25,9 @@ void nng_aio_set_msg(nng_aio *aio, nng_msg *msg); == DESCRIPTION The `nng_aio_set_msg()` function sets the message that will be used -for an asynchronous send operation (see `<<nng_send_aio.3#,nng_send_aio()>>`). +for an asynchronous send operation (see xref:nng_send_aio.3.adoc[`nng_send_aio()`]). -IMPORTANT: The `<<nng_aio.5#,nng_aio>>` must not have an operation in progress. +IMPORTANT: The xref:nng_aio.5.adoc[`nng_aio`] must not have an operation in progress. == RETURN VALUES @@ -40,8 +40,8 @@ None. == SEE ALSO [.text-left] -<<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, -<<nng_send_aio.3#,nng_send_aio(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_msg.5#,nng_msg(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_send_aio.3.adoc[nng_send_aio(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_set_output.3.adoc b/docs/man/nng_aio_set_output.3.adoc index 2314ef90..67f8ac66 100644 --- a/docs/man/nng_aio_set_output.3.adoc +++ b/docs/man/nng_aio_set_output.3.adoc @@ -39,7 +39,7 @@ NOTE: Note that attempts to set results with an _index_ greater than three (3) will be ignored. An output result set with this function may be retrieved later with -the `<<nng_aio_get_output.3#,nng_aio_get_output()>>` function. +the xref:nng_aio_get_output.3.adoc[`nng_aio_get_output()`] function. == RETURN VALUES @@ -52,9 +52,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_finish.3#,nng_aio_finish(3)>>, -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_finish.3.adoc[nng_aio_finish(3)], +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_set_timeout.3.adoc b/docs/man/nng_aio_set_timeout.3.adoc index f1a91e52..0d544d59 100644 --- a/docs/man/nng_aio_set_timeout.3.adoc +++ b/docs/man/nng_aio_set_timeout.3.adoc @@ -57,9 +57,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(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_aio_stop.3.adoc b/docs/man/nng_aio_stop.3.adoc index 4dc55a51..65a4790f 100644 --- a/docs/man/nng_aio_stop.3.adoc +++ b/docs/man/nng_aio_stop.3.adoc @@ -41,7 +41,7 @@ completing its callback function. TIP: When multiple asynchronous I/O handles are in use and need to be shut down, it is safest to stop all of them, before deallocating any of -this with `<<nng_aio_free.3#,nng_aio_free()>>`, particularly if the callbacks +this with xref:nng_aio_free.3.adoc[`nng_aio_free()`], particularly if the callbacks might attempt to reschedule additional operations. == RETURN VALUES @@ -55,9 +55,9 @@ None. == SEE ALSO [.text-left] -<<nng_aio_cancel.3#,nng_aio_cancel(3)>>, -<<nng_aio_free.3#,nng_aio_free(3)>>, -<<nng_aio_wait.3#,nng_aio_wait(3)>>, -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], +xref:nng_aio_free.3.adoc[nng_aio_free(3)], +xref:nng_aio_wait.3.adoc[nng_aio_wait(3)], +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_aio_wait.3.adoc b/docs/man/nng_aio_wait.3.adoc index ce751133..5b65c79e 100644 --- a/docs/man/nng_aio_wait.3.adoc +++ b/docs/man/nng_aio_wait.3.adoc @@ -43,7 +43,7 @@ None. == SEE ALSO [.text-left] -<<nng_aio_abort.3#,nng_aio_abort(3)>>, -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_alloc.3.adoc b/docs/man/nng_alloc.3.adoc index fdde0023..93c03111 100644 --- a/docs/man/nng_alloc.3.adoc +++ b/docs/man/nng_alloc.3.adoc @@ -29,9 +29,9 @@ at least _size_ bytes. The memory will be 64-bit aligned. The returned memory can be used to hold message buffers, in which -case it can be directly passed to `<<nng_send.3#,nng_send()>>` using +case it can be directly passed to xref:nng_send.3.adoc[`nng_send()`] using the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no -longer needed using `<<nng_free.3#,nng_free()>>`. +longer needed using xref:nng_free.3.adoc[`nng_free()`]. IMPORTANT: Do not use the system `free()` function to release this memory. On some platforms this may work, but it is not guaranteed and may lead @@ -50,7 +50,7 @@ treated the same as `NNG_ENOMEM`. == SEE ALSO [.text-left] -<<nng_free.3#,nng_free(3)>>, -<<nng_send.3#,nng_send(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_free.3.adoc[nng_free(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_bus.7.adoc b/docs/man/nng_bus.7.adoc index aa8ed2ce..c79e2d9d 100644 --- a/docs/man/nng_bus.7.adoc +++ b/docs/man/nng_bus.7.adoc @@ -49,7 +49,7 @@ the more likely that message loss is to occur. === Socket Operations -The `<<nng_bus_open.3#,nng_bus0_open()>>` functions create a bus socket. +The xref:nng_bus_open.3.adoc[`nng_bus0_open()`] functions create a bus socket. This socket may be used to send and receive messages. Sending messages will attempt to deliver to each directly connected peer. @@ -64,12 +64,12 @@ The _bus_ protocol has no protocol-specific options. === Protocol Headers -When using a "`<<nng.7#raw_mode,raw>>`" _bus_ socket, received messages will -contain the incoming <<nng_pipe.5#,pipe>> ID as the sole element in the header. +When using a xref:nng.7.adoc#raw_mode["`raw`"] _bus_ socket, received messages will +contain the incoming xref:nng_pipe.5.adoc[pipe] ID as the sole element in the header. 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 <<nng_device.3#device,device>> +This behavior is intended for use with xref:nng_device.3#device,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. @@ -80,5 +80,5 @@ When using "`cooked`" _bus_ sockets, no message headers are present. == SEE ALSO [.text-left] -<<nng_bus_open.3#,nng_bus_open(3)>>, -<<nng.7#,nng(7)>> +xref:nng_bus_open.3.adoc[nng_bus_open(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_bus_open.3.adoc b/docs/man/nng_bus_open.3.adoc index 072074e1..3477a903 100644 --- a/docs/man/nng_bus_open.3.adoc +++ b/docs/man/nng_bus_open.3.adoc @@ -27,12 +27,12 @@ int nng_bus0_open_raw(nng_socket *s); == DESCRIPTION -The `nng_bus0_open()` function creates a <<nng_bus.7#,_bus_>> version 0 -<<nng_socket.5#,socket>> and returns it at the location pointed to by _s_. +The `nng_bus0_open()` function creates a xref:nng_bus.7.adoc[_bus_] version 0 +xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. -The `nng_bus0_open_raw()` function creates a <<nng_bus.7#,_bus_>> version 0 -<<nng_socket.5#,socket>> in -<<nng.7#raw_mode,raw>> mode, and returns it at the location pointed to by _s_. +The `nng_bus0_open_raw()` function creates a xref:nng_bus.7.adoc[_bus_] 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,6 +47,6 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_socket.5#,nng_socket(5)>>, -<<nng_bus.7#,nng_bus(7)>>, -<<nng.7#,nng(7)>> +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng_bus.7.adoc[nng_bus(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_clock.3supp.adoc b/docs/man/nng_clock.3supp.adoc index 18187824..500134c5 100644 --- a/docs/man/nng_clock.3supp.adoc +++ b/docs/man/nng_clock.3supp.adoc @@ -38,7 +38,7 @@ IMPORTANT: The reference time will be the same for a given program, but different programs may have different references. TIP: This function is intended mostly to help with setting appropriate -timeouts using <<nng_cv_until.3supp#,nng_cv_until(3supp)>>. +timeouts using xref:nng_cv_until.3supp.adoc[`nng_cv_until()`]. == RETURN VALUES @@ -51,9 +51,9 @@ None. == SEE ALSO [.text-left] -<<nng_sleep_aio.3#,nng_sleep_aio(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_cv_until.3supp#,nng_cv_until(3supp)>>, -<<nng_msleep.3supp#,nng_msleep(3supp)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng.7#,nng(7)>> +xref:nng_sleep_aio.3.adoc[nng_sleep_aio(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_cv_until.3supp.adoc[nng_cv_until(3supp)], +xref:nng_msleep.3supp.adoc[nng_msleep(3supp)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc index 4456f1c0..1867df07 100644 --- a/docs/man/nng_close.3.adoc +++ b/docs/man/nng_close.3.adoc @@ -38,7 +38,7 @@ of that data. There is no automatic linger or flush to ensure that the socket send buffers have completely transmitted. It is recommended to wait a brief period after calling -`<<nng_send.3#,nng_send()>>` or similar functions, before calling this +xref:nng_send.3.adoc[`nng_send()`] or similar functions, before calling this function. == RETURN VALUES @@ -53,7 +53,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +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_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc index 0276663c..c70e1752 100644 --- a/docs/man/nng_compat.3compat.adoc +++ b/docs/man/nng_compat.3compat.adoc @@ -35,24 +35,24 @@ nng_compat - compatibility with nanomsg 1.0 == DESCRIPTION (((compatibility layer))) -The <<nng.7#,_nng_>> library provides source-level compatibility for +The xref:nng.7.adoc[_nng_] library provides source-level compatibility for most _nanomsg_ 1.0 applications. IMPORTANT: This is intended to facilitate converting ((legacy applications)) to use the _nng_ library. -New applications should use the newer <<nng.7#,_nng_>> API instead. +New applications should use the newer xref:nng.7.adoc[_nng_] API instead. Applications making use of this must take care -to link with <<libnng.3#,_libnng_>> instead of _libnn_. +to link with xref:libnng.3.adoc[_libnng_] instead of _libnn_. TIP: While not recommended for long term use, the value returned by -<<nng_socket_id.3#,nng_socket_id()>> can be used with these functions -just like a value returned by <<nn_socket.3compat#,nn_socket()>>. +xref:nng_socket_id.3.adoc[`nng_socket_id()`] can be used with these functions +just like a value returned by xref:nn_socket.3compat.adoc[`nn_socket()`]. This can be way to facilitate incremental transition to the new API. NOTE: Some capabilities, protocols, and transports, will not be accessible using this API, as the compatible API has no provision for expression -of certain concepts introduced in the newer <<nng.7#,_nng_>> API. +of certain concepts introduced in the newer xref:nng.7.adoc[_nng_] API. NOTE: While reasonable efforts have been made to provide for compatibility, some things may behave differently, and some less common parts of the @@ -99,53 +99,53 @@ The following functions are provided: // this and use tables there -- it looks ugly otherwise. ifndef::backend-pdf[] [horizontal] -`<<nn_socket.3compat#,nn_socket()>>`:: create socket -`<<nn_getsockopt.3compat#,nn_getsockopt()>>`:: get socket option -`<<nn_setsockopt.3compat#,nn_setsockopt()>>`:: set socket option -`<<nn_bind.3compat#,nn_bind()>>`:: accept connections from remote peers -`<<nn_connect.3compat#,nn_connect()>>`:: connect to remote peer -`<<nn_send.3compat#,nn_send()>>`:: send data -`<<nn_recv.3compat#,nn_recv()>>`:: receive data -`<<nn_shutdown.3compat#,nn_shutdown()>>`:: shut down endpoint -`<<nn_close.3compat#,nn_close()>>`:: close socket -`<<nn_poll.3compat#,nn_poll()>>`:: poll sockets -`<<nn_device.3compat#,nn_device()>>`:: create forwarding device -`<<nn_recvmsg.3compat#,nn_recvmsg()>>`:: receive message -`<<nn_sendmsg.3compat#,nn_sendmsg()>>`:: send message -`<<nn_cmsg.3compat#,nn_cmsg()>>`:: message control data -`<<nn_get_statistic.3compat#,nn_get_statistic()>>`:: get statistic (stub) -`<<nn_allocmsg.3compat#,nn_allocmsg()>>`:: allocate message -`<<nn_reallocmsg.3compat#,nn_reallocmsg()>>`:: reallocate message -`<<nn_freemsg.3compat#,nn_freemsg()>>`:: free message -`<<nn_errno.3compat#,nn_errno()>>`:: return most recent error -`<<nn_strerror.3compat#,nn_strerror()>>`:: return message for error -`<<nn_term.3compat#,nn_term()>>`:: terminate library +xref:nn_socket.3compat.adoc[`nn_socket()`]:: create socket +xref:nn_getsockopt.3compat.adoc[`nn_getsockopt()`]:: get socket option +xref:nn_setsockopt.3compat.adoc[`nn_setsockopt()`]:: set socket option +xref:nn_bind.3compat.adoc[`nn_bind()`]:: accept connections from remote peers +xref:nn_connect.3compat.adoc[`nn_connect()`]:: connect to remote peer +xref:nn_send.3compat.adoc[`nn_send()`]:: send data +xref:nn_recv.3compat.adoc[`nn_recv()`]:: receive data +xref:nn_shutdown.3compat.adoc[`nn_shutdown()`]:: shut down endpoint +xref:nn_close.3compat.adoc[`nn_close()`]:: close socket +xref:nn_poll.3compat.adoc[`nn_poll()`]:: poll sockets +xref:nn_device.3compat.adoc[`nn_device()`]:: create forwarding device +xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`]:: receive message +xref:nn_sendmsg.3compat.adoc[`nn_sendmsg()`]:: send message +xref:nn_cmsg.3compat.adoc[`nn_cmsg()`]:: message control data +xref:nn_get_statistic.3compat.adoc[`nn_get_statistic()`]:: get statistic (stub) +xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]:: allocate message +xref:nn_reallocmsg.3compat.adoc[`nn_reallocmsg()`]:: reallocate message +xref:nn_freemsg.3compat.adoc[`nn_freemsg()`]:: free message +xref:nn_errno.3compat.adoc[`nn_errno()`]:: return most recent error +xref:nn_strerror.3compat.adoc[`nn_strerror()`]:: return message for error +xref:nn_term.3compat.adoc[`nn_term()`]:: terminate library endif::[] ifdef::backend-pdf[] // Add links for the following as they are written. [.hdlist,width=90%, grid=rows,cols="1,2", align="center"] |=== -|`<<nn_socket.3compat#,nn_socket()>>`|create socket -|`<<nn_getsockopt.3compat#,nn_getsockopt()>>`|get socket option -|`<<nn_setsockopt.3compat#,nn_setsockopt()>>`|set socket option -|`<<nn_bind.3compat#,nn_bind()>>`|accept connections from remote peers -|`<<nn_connect.3compat#,nn_connect()>>`|connect to remote peer -|`<<nn_send.3compat#,nn_send()>>`|send data -|`<<nn_recv.3compat#,nn_recv()>>`|receive data -|`<<nn_shutdown.3compat#,nn_shutdown()>>`|shut down endpoint -|`<<nn_close.3compat#,nn_close()>>`|close socket -|`<<nn_poll.3compat#,nn_poll()>>`|poll sockets -|`<<nn_device.3compat#,nn_device()>>`|create forwarding device -|`<<nn_recvmsg.3compat#,nn_recvmsg()>>`|receive message -|`<<nn_sendmsg.3compat#,nn_sendmsg()>>`|send message -|`<<nn_cmsg.3compat#,nn_cmsg()>>`|message control data -|`<<nn_get_statistic.3compat#,nn_get_statistic()>>`|get statistic (stub) -|`<<nn_allocmsg.3compat#,nn_allocmsg()>>`|allocate message -|`<<nn_reallocmsg.3compat#,nn_reallocmsg()>>`|reallocate message -|`<<nn_freemsg.3compat#,nn_freemsg()>>`|free message -|`<<nn_errno.3compat#,nn_errno()>>`|return most recent error -|`<<nn_strerror.3compat#,nn_strerror()>>`|return message for error -|`<<nn_term.3compat#,nn_term()>>`|terminate library +|xref:nn_socket.3compat.adoc[`nn_socket()`]|create socket +|xref:nn_getsockopt.3compat.adoc[`nn_getsockopt()`]|get socket option +|xref:nn_setsockopt.3compat.adoc[`nn_setsockopt()`]|set socket option +|xref:nn_bind.3compat.adoc[`nn_bind()`]|accept connections from remote peers +|xref:nn_connect.3compat.adoc[`nn_connect()`]|connect to remote peer +|xref:nn_send.3compat.adoc[`nn_send()`]|send data +|xref:nn_recv.3compat.adoc[`nn_recv()`]|receive data +|xref:nn_shutdown.3compat.adoc[`nn_shutdown()`]|shut down endpoint +|xref:nn_close.3compat.adoc[`nn_close()`]|close socket +|xref:nn_poll.3compat.adoc[`nn_poll()`]|poll sockets +|xref:nn_device.3compat.adoc[`nn_device()`]|create forwarding device +|xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`]|receive message +|xref:nn_sendmsg.3compat.adoc[`nn_sendmsg()`]|send message +|xref:nn_cmsg.3compat.adoc[`nn_cmsg()`]|message control data +|xref:nn_get_statistic.3compat.adoc[`nn_get_statistic()`]|get statistic (stub) +|xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]|allocate message +|xref:nn_reallocmsg.3compat.adoc[`nn_reallocmsg()`]|reallocate message +|xref:nn_freemsg.3compat.adoc[`nn_freemsg()`]|free message +|xref:nn_errno.3compat.adoc[`nn_errno()`]|return most recent error +|xref:nn_strerror.3compat.adoc[`nn_strerror()`]|return message for error +|xref:nn_term.3compat.adoc[`nn_term()`]|terminate library |=== endif::[] @@ -167,7 +167,7 @@ The following caveats apply when using the legacy API with _nng_. the underlying capability is present in _nng_. * Access to statistics using this legacy API - (`<<nn_get_statistic.3compat#,nn_get_statistic()>>`) is unsupported. + (xref:nn_get_statistic.3compat.adoc[`nn_get_statistic()`]) is unsupported. * Some transports can support longer URLs than legacy _libnanomsg_ can. It is a good idea to use short pathnames in URLs if interoperability @@ -210,5 +210,5 @@ The following caveats apply when using the legacy API with _nng_. == SEE ALSO [.text-left] -<<libnng.3#,libnng(3)>>, -<<nng.7#,nng(7)>> +xref:libnng.3.adoc[libnng(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_close.3.adoc b/docs/man/nng_ctx_close.3.adoc index 639515ba..cfc51bfa 100644 --- a/docs/man/nng_ctx_close.3.adoc +++ b/docs/man/nng_ctx_close.3.adoc @@ -34,7 +34,7 @@ Threads waiting for operations on the context when this call is executed may also return with an `NNG_ECLOSED` result. NOTE: Closing the socket associated with _ctx_ -(using `<<nng_close.3#,nng_close()>>`) also closes this context. +(using xref:nng_close.3.adoc[`nng_close()`]) also closes this context. == RETURN VALUES @@ -48,7 +48,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ctx_open.3#,nng_ctx_open(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx_open.3.adoc[nng_ctx_open(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_ctx.5.adoc[nng_ctx(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_get.3.adoc b/docs/man/nng_ctx_get.3.adoc index e6e9cc1f..3ba3f072 100644 --- a/docs/man/nng_ctx_get.3.adoc +++ b/docs/man/nng_ctx_get.3.adoc @@ -39,9 +39,9 @@ int nng_ctx_get_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p); (((options, context))) The `nng_ctx_get()` functions are used to retrieve option values for -the <<nng_ctx.5#,context>> _ctx_. +the xref:nng_ctx.5.adoc[context] _ctx_. The actual options that may be retrieved in this way vary. -A number of them are documented in <<nng_options.5#,nng_options(5)>>. +A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. NOTE: Context options are protocol specific. The details will be documented with the protocol. @@ -83,7 +83,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_ctx_get_ms()`:: -This function is used to retrieve time <<nng_duration.5#,durations>> +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.) @@ -94,9 +94,9 @@ typically for buffer sizes, message maximum sizes, and similar options. `nng_ctx_get_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_ctx_get_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -121,11 +121,11 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ctx_set.3#,nng_ctx_set(3)>>, -<<nng_strdup.3#,nng_strdup(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_strfree.3#,nng_strfree(3)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx_set.3.adoc[nng_ctx_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_ctx.5.adoc[nng_ctx(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_getopt.3.adoc b/docs/man/nng_ctx_getopt.3.adoc index 2ae8b992..daba5e59 100644 --- a/docs/man/nng_ctx_getopt.3.adoc +++ b/docs/man/nng_ctx_getopt.3.adoc @@ -41,9 +41,9 @@ NOTE: These functions are deprecated. Please see xref:nng_ctx_get.3.adoc[nng_ct (((options, context))) The `nng_ctx_getopt()` functions are used to retrieve option values for -the <<nng_ctx.5#,context>> _ctx_. +the xref:nng_ctx.5.adoc[context] _ctx_. The actual options that may be retrieved in this way vary. -A number of them are documented in <<nng_options.5#,nng_options(5)>>. +A number of them are documented in xref:nng_options.5.adoc[nng_options(5)]. NOTE: Context options are protocol specific. The details will be documented with the protocol. @@ -85,7 +85,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_ctx_getopt_ms()`:: -This function is used to retrieve time <<nng_duration.5#,durations>> +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.) @@ -96,9 +96,9 @@ typically for buffer sizes, message maximum sizes, and similar options. `nng_ctx_getopt_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_ctx_getopt_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -123,11 +123,11 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ctx_setopt.3#,nng_ctx_setopt(3)>>, -<<nng_strdup.3#,nng_strdup(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_strfree.3#,nng_strfree(3)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx_setopt.3.adoc[nng_ctx_setopt(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_ctx.5.adoc[nng_ctx(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_id.3.adoc b/docs/man/nng_ctx_id.3.adoc index 93b0d02d..51b833a8 100644 --- a/docs/man/nng_ctx_id.3.adoc +++ b/docs/man/nng_ctx_id.3.adoc @@ -29,10 +29,10 @@ if it is valid. Otherwise it returns `-1`. NOTE: A context is considered valid if it was ever opened with -`<<nng_ctx_open.3#,nng_ctx_open()>>` function. +xref:nng_ctx_open.3.adoc[`nng_ctx_open()`] function. Contexts that are allocated on the stack or statically should be initialized with the macro -`<<nng_ctx.5#NNG_CTX_INITIALIZER,NNG_CTX_INITIALIZER>>` to ensure that +xref:nng_ctx.5.adoc#NNG_CTX_INITIALIZER[`NNG_CTX_INITIALIZER`] to ensure that they cannot be confused with a valid context before they are opened. == RETURN VALUES @@ -47,5 +47,5 @@ None. == SEE ALSO [.text-left] -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx.5.adoc[nng_ctx(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_open.3.adoc b/docs/man/nng_ctx_open.3.adoc index 7c799078..76842b7e 100644 --- a/docs/man/nng_ctx_open.3.adoc +++ b/docs/man/nng_ctx_open.3.adoc @@ -32,7 +32,7 @@ NOTE: Not every protocol supports creation of separate contexts. Contexts allow the independent and concurrent use of stateful operations using the same socket. -For example, two different contexts created on a <<nng_rep.7#,_rep_>> +For example, two different contexts created on a xref:nng_rep.7.adoc[_rep_] socket can each receive requests, and send replies to them, without any regard to or interference with each other. @@ -40,9 +40,9 @@ regard to or interference with each other. TIP: Using contexts is an excellent way to write simpler concurrent applications, while retaining the benefits of the protocol-specific advanced processing, avoiding the need to bypass that with -<<nng.7#raw_mode,raw mode>> sockets. +xref:nng.7.adoc#raw_mode[raw mode] sockets. -NOTE: Use of contexts with <<nng.7#raw_mode,raw mode>> sockets is +NOTE: Use of contexts with xref:nng.7.adoc#raw_mode[raw mode] sockets is nonsensical, and not supported. == RETURN VALUES @@ -58,14 +58,14 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ctx_close.3#,nng_ctx_close(3)>>, -<<nng_ctx_getopt.3#,nng_ctx_getopt(3)>>, -<<nng_ctx_recv.3#,nng_ctx_recv(3)>>, -<<nng_ctx_send.3#,nng_ctx_send(3)>>, -<<nng_ctx_setopt.3#,nng_ctx_setopt(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng_rep.7#,nng_rep(7)>>, -<<nng_req.7#,nng_req(7)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx_close.3.adoc[nng_ctx_close(3)], +xref:nng_ctx_getopt.3.adoc[nng_ctx_getopt(3)], +xref:nng_ctx_recv.3.adoc[nng_ctx_recv(3)], +xref:nng_ctx_send.3.adoc[nng_ctx_send(3)], +xref:nng_ctx_setopt.3.adoc[nng_ctx_setopt(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_ctx.5.adoc[nng_ctx(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_ctx_recv.3.adoc b/docs/man/nng_ctx_recv.3.adoc index 81e4de30..bb3d7cf6 100644 --- a/docs/man/nng_ctx_recv.3.adoc +++ b/docs/man/nng_ctx_recv.3.adoc @@ -24,14 +24,14 @@ void nng_ctx_recv(nng_ctx ctx, nng_aio *aio); == DESCRIPTION -The `nng_ctx_recv()` receives a <<nng_msg.5#,message>> using the -<<nng_ctx.5#,context>> _s_ asynchronously. +The `nng_ctx_recv()` receives a xref:nng_msg.5.adoc[message] using the +xref:nng_ctx.5.adoc[context] _s_ asynchronously. When a message is successfully received by the context, it is stored in the _aio_ by an internal call equivalent to -`<<nng_aio_set_msg.3#,nng_aio_set_msg()>>`, 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, `<<nng_aio_result.3#,nng_aio_result()>>` 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,7 +42,7 @@ 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 `<<nng_aio_result.3#,nng_aio_result()>>` 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. @@ -64,11 +64,11 @@ None. (The operation completes asynchronously.) == SEE ALSO [.text-left] -<<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, -<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, -<<nng_msg_alloc.3#,nng_msg_alloc(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_msg.5#,nng_msg(5)>>, -<<nng.7#,nng(7)>> +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_ctx.5.adoc[nng_ctx(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_send.3.adoc b/docs/man/nng_ctx_send.3.adoc index b7c264ad..3284ac8a 100644 --- a/docs/man/nng_ctx_send.3.adoc +++ b/docs/man/nng_ctx_send.3.adoc @@ -24,15 +24,15 @@ void nng_ctx_send(nng_ctx ctx, nng_aio *aio); == DESCRIPTION -The `nng_ctx_send()` sends a <<nng_msg.5#,message>> using the -<<nng_ctx.5#,context>> _ctx_ asynchronously. +The `nng_ctx_send()` sends a xref:nng_msg.5.adoc[message] using the +xref:nng_ctx.5.adoc[context] _ctx_ asynchronously. The message to send must have previously been set on the _aio_ -using the `<<nng_aio_set_msg.3#,nng_aio_set_msg()>>` 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 `<<nng_aio_result.3#,nng_aio_result()>>` +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,12 +45,12 @@ 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 -`<<nng_aio_result.3#,nng_aio_result()>>` will return a non-zero error status. +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 `<<nng_aio_get_msg.3#,nng_aio_get_msg()>>` and dispose of +the _aio_ with 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 `<<nng_msg_free.3#,nng_msg_free()>>`.) +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. @@ -58,7 +58,7 @@ protocol, so examination of the protocol documentation is encouraged. TIP: Context send operations are asynchronous. If a synchronous operation is needed, one can be constructed by using a `NULL` callback on the _aio_ and then waiting for the operation using -`<<nng_aio_wait.3#,nng_aio_wait()>>`. +xref:nng_aio_wait.3.adoc[`nng_aio_wait()`]. == RETURN VALUES @@ -78,11 +78,11 @@ None. (The operation completes asynchronously.) == SEE ALSO [.text-left] -<<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>, -<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>, -<<nng_msg_alloc.3#,nng_msg_alloc(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_aio.5#,nng_aio(5)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_msg.5#,nng_msg(5)>>, -<<nng.7#,nng(7)>> +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_ctx.5.adoc[nng_ctx(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ctx_set.3.adoc b/docs/man/nng_ctx_set.3.adoc index 8c9c5095..9bfeb43f 100644 --- a/docs/man/nng_ctx_set.3.adoc +++ b/docs/man/nng_ctx_set.3.adoc @@ -69,7 +69,7 @@ The _ival_ is passed to the option. `nng_ctx_set_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<<nng_duration.5#,nng_duration>>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_ctx_set_size()`:: @@ -104,10 +104,10 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ctx_get.3#,nng_ctx_get(3)>>, -<<nng_socket_set.3#,nng_socket_set(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx_get.3.adoc[nng_ctx_get(3)], +xref:nng_socket_set.3.adoc[nng_socket_set(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_ctx.5.adoc[nng_ctx(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_ctx_setopt.3.adoc b/docs/man/nng_ctx_setopt.3.adoc index 478410b5..1fd36e66 100644 --- a/docs/man/nng_ctx_setopt.3.adoc +++ b/docs/man/nng_ctx_setopt.3.adoc @@ -69,7 +69,7 @@ The _ival_ is passed to the option. `nng_ctx_setopt_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<<nng_duration.5#,nng_duration>>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_ctx_setopt_size()`:: @@ -104,10 +104,10 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ctx_getopt.3#,nng_ctx_getopt(3)>>, -<<nng_setopt.3#,nng_setopt(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_ctx.5#,nng_ctx(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +xref:nng_ctx_getopt.3.adoc[nng_ctx_getopt(3)], +xref:nng_setopt.3.adoc[nng_setopt(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_ctx.5.adoc[nng_ctx(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_cv_alloc.3supp.adoc b/docs/man/nng_cv_alloc.3supp.adoc index e80c3ce7..9e58e3f1 100644 --- a/docs/man/nng_cv_alloc.3supp.adoc +++ b/docs/man/nng_cv_alloc.3supp.adoc @@ -32,11 +32,11 @@ the mutex _mtx_, and returns it in _cvp_. Every condition variable is associated with a mutex, which must be owned when a thread waits for the condition using -`<<nng_cv_wait.3supp#,nng_cv_wait()>>` or -`<<nng_cv_until.3supp#,nng_cv_until()>>`. +xref:nng_cv_wait.3supp.adoc[`nng_cv_wait()`] or +xref:nng_cv_until.3supp.adoc[`nng_cv_until()`]. The mutex must also be owned when signaling the condition using the -`<<nng_cv_wake.3supp#,nng_cv_wake()>>` or -`<<nng_cv_wake1.3supp#,nng_cv_wake1()>>` functions. +xref:nng_cv_wake.3supp.adoc[`nng_cv_wake()`] or +xref:nng_cv_wake1.3supp.adoc[`nng_cv_wake1()`] functions. == RETURN VALUES @@ -50,11 +50,11 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_cv_free.3supp#,nng_cv_free(3supp)>>, -<<nng_cv_until.3supp#,nng_cv_until(3supp)>>, -<<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, -<<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>, -<<nng_cv_wake1.3supp#,nng_cv_wake1(3supp)>>, -<<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_cv_free.3supp.adoc[nng_cv_free(3supp)], +xref:nng_cv_until.3supp.adoc[nng_cv_until(3supp)], +xref:nng_cv_wait.3supp.adoc[nng_cv_wait(3supp)], +xref:nng_cv_wake.3supp.adoc[nng_cv_wake(3supp)], +xref:nng_cv_wake1.3supp.adoc[nng_cv_wake1(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_cv_free.3supp.adoc b/docs/man/nng_cv_free.3supp.adoc index dc7e5ffd..0610b52f 100644 --- a/docs/man/nng_cv_free.3supp.adoc +++ b/docs/man/nng_cv_free.3supp.adoc @@ -38,5 +38,5 @@ None. == SEE ALSO [.text-left] -<<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, -<<nng.7#,nng(7)>> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_cv_until.3supp.adoc b/docs/man/nng_cv_until.3supp.adoc index 085d3c16..9300b295 100644 --- a/docs/man/nng_cv_until.3supp.adoc +++ b/docs/man/nng_cv_until.3supp.adoc @@ -26,9 +26,9 @@ int nng_cv_until(nng_cv *cv, nng_time when); == DESCRIPTION The `nng_cv_until()` waits until either the condition variable _cv_ is signaled -by another thread calling either `<<nng_cv_wake.3supp#,nng_cv_wake()>>` or -`<<nng_cv_wake1.3supp#,nng_cv_wake1()>>`, or the system clock (as tracked -by `<<nng_clock.3supp#,nng_clock()>>`) reaches _when_. +by another thread calling either xref:nng_cv_wake.3supp.adoc[`nng_cv_wake()`] or +xref:nng_cv_wake1.3supp.adoc[`nng_cv_wake1()`], or the system clock (as tracked +by xref:nng_clock.3supp.adoc[`nng_clock()`]) reaches _when_. The caller must have have ownership of the mutex that was used when _cv_ was allocated. @@ -80,11 +80,11 @@ None. == SEE ALSO [.text-left] -<<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, -<<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, -<<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>, -<<nng_cv_wake1.3supp#,nng_cv_wake1(3supp)>>, -<<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, -<<nng_mtx_lock.3supp#,nng_mtx_lock(3supp)>>, -<<nng_mtx_unlock.3supp#,nng_mtx_unlock(3supp)>>, -<<nng.7#,nng(7)>> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_cv_wait.3supp.adoc[nng_cv_wait(3supp)], +xref:nng_cv_wake.3supp.adoc[nng_cv_wake(3supp)], +xref:nng_cv_wake1.3supp.adoc[nng_cv_wake1(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock(3supp)], +xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_cv_wait.3supp.adoc b/docs/man/nng_cv_wait.3supp.adoc index ab741815..673839b9 100644 --- a/docs/man/nng_cv_wait.3supp.adoc +++ b/docs/man/nng_cv_wait.3supp.adoc @@ -26,8 +26,8 @@ void nng_cv_wait(nng_cv *cv); == DESCRIPTION The `nng_cv_wait()` waits for the condition variable _cv_ to be signaled -by another thread calling either `<<nng_cv_wake.3supp#,nng_cv_wake()>>` or -`<<nng_cv_wake1.3supp#,nng_cv_wake1()>>`. +by another thread calling either xref:nng_cv_wake.3supp.adoc[`nng_cv_wake()`] or +xref:nng_cv_wake1.3supp.adoc[`nng_cv_wake1()`]. The caller must have have ownership of the mutex that was used when _cv_ was allocated. @@ -76,11 +76,11 @@ None. == SEE ALSO [.text-left] -<<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, -<<nng_cv_until.3supp#,nng_cv_until(3supp)>>, -<<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>, -<<nng_cv_wake1.3supp#,nng_cv_wake1(3supp)>>, -<<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, -<<nng_mtx_lock.3supp#,nng_mtx_lock(3supp)>>, -<<nng_mtx_unlock.3supp#,nng_mtx_unlock(3supp)>>, -<<nng.7#,nng(7)>> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_cv_until.3supp.adoc[nng_cv_until(3supp)], +xref:nng_cv_wake.3supp.adoc[nng_cv_wake(3supp)], +xref:nng_cv_wake1.3supp.adoc[nng_cv_wake1(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock(3supp)], +xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_cv_wake.3supp.adoc b/docs/man/nng_cv_wake.3supp.adoc index 569e4aef..a42191c6 100644 --- a/docs/man/nng_cv_wake.3supp.adoc +++ b/docs/man/nng_cv_wake.3supp.adoc @@ -26,8 +26,8 @@ void nng_cv_wake(nng_cv *cv); == DESCRIPTION The `nng_cv_wake()` wakes any threads waiting for the condition variable _cv_ -to be signaled in the `<<nng_cv_wait.3supp#,nng_cv_wait()>>` or -`<<nng_cv_until.3supp#,nng_cv_until()>>` functions. +to be signaled in the xref:nng_cv_wait.3supp.adoc[`nng_cv_wait()`] or +xref:nng_cv_until.3supp.adoc[`nng_cv_until()`] functions. The caller must have have ownership of the mutex that was used when _cv_ was allocated. @@ -38,7 +38,7 @@ will check, while holding the mutex. TIP: This function wakes all threads, which is generally safer but can lead to a problem known as the "`thundering herd`" when there are many waiters, as they are all woken simultaneously. -See `<<nng_cv_wake1.3supp#,nng_cv_wake1()>>` for a solution to this problem. +See xref:nng_cv_wake1.3supp.adoc[`nng_cv_wake1()`] for a solution to this problem. == RETURN VALUES @@ -51,11 +51,11 @@ None. == SEE ALSO [.text-left] -<<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, -<<nng_cv_until.3supp#,nng_cv_until(3supp)>>, -<<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, -<<nng_cv_wake1.3supp#,nng_cv_wake1(3supp)>>, -<<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, -<<nng_mtx_lock.3supp#,nng_mtx_lock(3supp)>>, -<<nng_mtx_unlock.3supp#,nng_mtx_unlock(3supp)>>, -<<nng.7#,nng(7)>> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_cv_until.3supp.adoc[nng_cv_until(3supp)], +xref:nng_cv_wait.3supp.adoc[nng_cv_wait(3supp)], +xref:nng_cv_wake1.3supp.adoc[nng_cv_wake1(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock(3supp)], +xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_cv_wake1.3supp.adoc b/docs/man/nng_cv_wake1.3supp.adoc index cea7387c..2dd23129 100644 --- a/docs/man/nng_cv_wake1.3supp.adoc +++ b/docs/man/nng_cv_wake1.3supp.adoc @@ -27,8 +27,8 @@ void nng_cv_wake1(nng_cv *cv); The `nng_cv_wake1()` wakes at most one thread waiting for the condition variable _cv_ -to be signaled in the `<<nng_cv_wait.3supp#,nng_cv_wait()>>` or -`<<nng_cv_until.3supp#,nng_cv_until()>>` functions. +to be signaled in the xref:nng_cv_wait.3supp.adoc[`nng_cv_wait()`] or +xref:nng_cv_until.3supp.adoc[`nng_cv_until()`] functions. The caller must have have ownership of the mutex that was used when _cv_ was allocated. @@ -39,7 +39,7 @@ will check, while holding the mutex. TIP: While this function avoids the "`thundering herd`" problem, the caller cannot predict which waiter will be woken, and so the design must ensure that it is sufficient that _any_ waiter be woken. -When in doubt, it is safer to use `<<nng_cv_wake.3supp#,nng_cv_wake()>>`. +When in doubt, it is safer to use xref:nng_cv_wake.3supp.adoc[`nng_cv_wake()`]. == RETURN VALUES @@ -52,11 +52,11 @@ None. == SEE ALSO [.text-left] -<<nng_cv_alloc.3supp#,nng_cv_alloc(3supp)>>, -<<nng_cv_until.3supp#,nng_cv_until(3supp)>>, -<<nng_cv_wait.3supp#,nng_cv_wait(3supp)>>, -<<nng_cv_wake.3supp#,nng_cv_wake(3supp)>>, -<<nng_mtx_alloc.3supp#,nng_mtx_alloc(3supp)>>, -<<nng_mtx_lock.3supp#,nng_mtx_lock(3supp)>>, -<<nng_mtx_unlock.3supp#,nng_mtx_unlock(3supp)>>, -<<nng.7#,nng(7)>> +xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc(3supp)], +xref:nng_cv_until.3supp.adoc[nng_cv_until(3supp)], +xref:nng_cv_wait.3supp.adoc[nng_cv_wait(3supp)], +xref:nng_cv_wake.3supp.adoc[nng_cv_wake(3supp)], +xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)], +xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock(3supp)], +xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock(3supp)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_device.3.adoc b/docs/man/nng_device.3.adoc index ad6048af..a8a6ce27 100644 --- a/docs/man/nng_device.3.adoc +++ b/docs/man/nng_device.3.adoc @@ -25,16 +25,16 @@ int nng_device(nng_socket s1, nng_socket s2); == DESCRIPTION The `nng_device()` function forwards messages received from one -<<nng_socket.5#,socket>> _s1_ to another socket _s2_, and vice versa. +xref:nng_socket.5.adoc[socket] _s1_ to another socket _s2_, and vice versa. This function is used to create forwarders, which can be used to create complex network topologies to provide for improved ((horizontal scalability)), reliability, and isolation. -Only <<nng_options.5#NNG_OPT_RAW,raw>> mode sockets may be used with this +Only xref:nng_options.5.adoc#NNG_OPT_RAW[raw] mode sockets may be used with this function. These can be created using `_raw` forms of the various socket constructors, -such as `<<nng_req_open.3#,nng_req0_open_raw()>>`. +such as xref:nng_req_open.3.adoc[`nng_req0_open_raw()`]. The `nng_device()` function does not return until one of the sockets is closed. @@ -45,8 +45,8 @@ One of the sockets passed may be an unopened socket initialized with the `NNG_SOCKET_INITIALIZER` special value. If this is the case, then the other socket must be valid, and must use a protocol that is bidirectional and can peer with itself (such as -<<nng_pair.7#,_pair_>> or -<<nng_bus.7#,_bus_>>.) +xref:nng_pair.7.adoc[_pair_] or +xref:nng_bus.7.adoc[_bus_].) In this case the device acts as a ((reflector)) or loop-back device, where messages received from the valid socket are merely returned back to the sender. @@ -58,9 +58,9 @@ In this case sockets _s1_ and _s2_ must be "`compatible`" with each other, which is to say that they should represent the opposite halves of a two protocol pattern, or both be the same protocol for a single protocol pattern. -For example, if _s1_ is a <<nng_pub.7#,_pub_>> socket, then _s2_ must -be a <<nng_sub.7#,_sub_>> socket. -Or, if _s1_ is a <<nng_bus.7#,_bus_>> socket, then _s2_ must also +For example, if _s1_ is a xref:nng_pub.7.adoc[_pub_] socket, then _s2_ must +be a xref:nng_sub.7.adoc[_sub_] socket. +Or, if _s1_ is a xref:nng_bus.7.adoc[_bus_] socket, then _s2_ must also be a _bus_ socket. === Operation @@ -81,7 +81,7 @@ In these cases, the default limit (usually 8), ensures that messages will self-terminate when they have passed through too many forwarders, protecting the network from unlimited message amplification that can arise through misconfiguration. -This is controlled via the `<<nng_options.5#NNG_OPT_MAXTTL,NNG_OPT_MAXTTL>>` +This is controlled via the xref:nng_options.5.adoc#NNG_OPT_MAXTTL[`NNG_OPT_MAXTTL`] option. IMPORTANT: Not all protocols have support for guarding against forwarding loops, @@ -110,6 +110,6 @@ one occurs, or if one of the sockets is closed. == SEE ALSO [.text-left] -<<nng_options.5#,nng_options(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +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_dial.3.adoc b/docs/man/nng_dial.3.adoc index 1605f08a..690537a5 100644 --- a/docs/man/nng_dial.3.adoc +++ b/docs/man/nng_dial.3.adoc @@ -25,7 +25,7 @@ int nng_dial(nng_socket s, const char *url, nng_dialer *dp, int flags); == DESCRIPTION The `nng_dial()` function creates a newly initialized -`<<nng_dialer.5#,nng_dialer>>` object, +xref:nng_dialer.5.adoc[`nng_dialer`] object, associated with socket _s_, and configured to dial the address specified by _url_, and starts it. If the value of _dp_ is not `NULL`, then @@ -33,7 +33,7 @@ the newly created dialer is stored at the address indicated by _dp_. Dialers initiate a remote connection to a listener. Upon a successful -connection being established, they create a <<nng_pipe.5#,pipe>>, +connection being established, they create a xref:nng_pipe.5.adoc[pipe], add it to the socket, and then wait for that pipe to be closed. When the pipe is closed, the dialer attempts to re-establish the connection. Dialers will also periodically retry a connection automatically if an attempt @@ -42,7 +42,7 @@ to connect asynchronously fails. TIP: While it is convenient to think of dialers as "`clients`", 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 <<nng_req.7#,_req_>> +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! @@ -62,8 +62,8 @@ it also generally makes diagnosing failures somewhat more difficult. Because the dialer is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using `<<nng_dialer_create.3#,nng_dialer_create()>>` and -`<<nng_dialer_start.3#,nng_dialer_start()>>` instead. +using xref:nng_dialer_create.3.adoc[`nng_dialer_create()`] and +xref:nng_dialer_start.3.adoc[`nng_dialer_start()`] instead. == RETURN VALUES @@ -85,11 +85,11 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_close.3#,nng_dialer_close(3)>>, -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_dialer_start.3#,nng_dialer_start(3)>>, -<<nng_listen.3#,nng_listen(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng_pipe.5#,nng_pipe(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_close.3.adoc[nng_dialer_close(3)], +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_dialer_start.3.adoc[nng_dialer_start(3)], +xref:nng_listen.3.adoc[nng_listen(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng_pipe.5.adoc[nng_pipe(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer.5.adoc b/docs/man/nng_dialer.5.adoc index cd639711..a2757e38 100644 --- a/docs/man/nng_dialer.5.adoc +++ b/docs/man/nng_dialer.5.adoc @@ -26,7 +26,7 @@ typedef struct nng_dialer_s nng_dialer; (((dialer))) An `nng_dialer` is a handle to a "`dialer`" object, which is responsible for -creating a single `<<nng_pipe.5#,nng_pipe>>` at a time by +creating a single xref:nng_pipe.5.adoc[`nng_pipe`] at a time by establishing an outgoing connection. If the connection is broken, or fails, the dialer object will automatically @@ -34,28 +34,28 @@ attempt to reconnect, and will keep doing so until the dialer or socket is destroyed. Dialer objects are created by the -`<<nng_dialer_create.3#,nng_dialer_create()>>` -or `<<nng_dial.3#,nng_dial()>>` functions, and are always "`owned`" -by a single `<<nng_socket.5#,nng_socket>>`. +xref:nng_dialer_create.3.adoc[`nng_dialer_create()`] +or xref:nng_dial.3.adoc[`nng_dial()`] functions, and are always "`owned`" +by a single xref:nng_socket.5.adoc[`nng_socket`]. IMPORTANT: The `nng_dialer` 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 `<<nng_socket.5#,nng_socket>>` may have multiple dialer -objects, multiple <<nng_listener.5#,listener>> objects, or even some +TIP: A given xref:nng_socket.5.adoc[`nng_socket`] may have multiple dialer +objects, multiple xref:nng_listener.5.adoc[listener] 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 <<nng_rep.7#,_rep_>> socket may use a dialer -to connect to a listener on an <<nng_req.7#,_req_>> 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. Dialer objects may be destroyed by the -`<<nng_dialer_close.3#,nng_dialer_close()>>` function. +xref:nng_dialer_close.3.adoc[`nng_dialer_close()`] function. They are also closed when their "`owning`" socket is closed. [[NNG_DIALER_INITIALIZER]] @@ -67,14 +67,14 @@ before it is opened, to prevent confusion with valid open dialers. == SEE ALSO [.text-left] -<<nng_dial.3#,nng_dial(3)>>, -<<nng_dialer_close.3#,nng_dialer_close(3)>>, -<<nng_dialer_create.3#,nng_dialer_create(3)>>, -<<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>, -<<nng_dialer_id.3#,nng_dialer_id(3)>>, -<<nng_dialer_setopt.3#,nng_dialer_setopt(3)>>, -<<nng_dialer_start.3#,nng_dialer_start(3)>>, -<<nng_listener.5#,nng_listener(5)>>, -<<nng_pipe.5#,nng_pipe(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dial.3.adoc[nng_dial(3)], +xref:nng_dialer_close.3.adoc[nng_dialer_close(3)], +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)], +xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt(3)], +xref:nng_dialer_id.3.adoc[nng_dialer_id(3)], +xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)], +xref:nng_dialer_start.3.adoc[nng_dialer_start(3)], +xref:nng_listener.5.adoc[nng_listener(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_dialer_close.3.adoc b/docs/man/nng_dialer_close.3.adoc index e1cf741f..6af73ae4 100644 --- a/docs/man/nng_dialer_close.3.adoc +++ b/docs/man/nng_dialer_close.3.adoc @@ -25,7 +25,7 @@ int nng_dialer_close(nng_dialer d); == DESCRIPTION The `nng_dialer_close()` function closes the dialer _d_. -This also closes any `<<nng_pipe.5#,nng_pipe>>` objects that have +This also closes any xref:nng_pipe.5.adoc[`nng_pipe`] objects that have been created by the dialer. Once this function returns, the dialer _d_ and any of its resources @@ -43,14 +43,14 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS [horizontal] -`NNG_ECLOSED`:: Parameter _d_ does not refer to an open listener. +`NNG_ECLOSED`:: Parameter _d_ does not refer to an open dialer. == SEE ALSO [.text-left] -<<nng_close.3#,nng_close(3)>>, -<<nng_dial.3#,nng_dial(3)>>, -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng.7#,nng(7)>> +xref:nng_close.3.adoc[nng_close(3)], +xref:nng_dial.3.adoc[nng_dial(3)], +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer_create.3.adoc b/docs/man/nng_dialer_create.3.adoc index c33c778b..497af2ab 100644 --- a/docs/man/nng_dialer_create.3.adoc +++ b/docs/man/nng_dialer_create.3.adoc @@ -25,7 +25,7 @@ int nng_dialer_create(nng_dialer *dialerp, nng_socket s, const char *url); == DESCRIPTION The `nng_dialer_create()` function creates a newly initialized -`<<nng_dialer.5#,nng_dialer>>` object, associated with socket _s_, +xref:nng_dialer.5.adoc[`nng_dialer`] object, associated with socket _s_, and configured to connect to the address specified by _url_, and stores a pointer to at the location referenced by _dialerp_. @@ -42,18 +42,18 @@ fails. TIP: While it is convenient to think of dialers as "`clients`", 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 <<nng_req.7#,_req_>> +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 dialer is not started, but may be further configured with -the `<<nng_dialer_setopt.3#,nng_dialer_setopt()>>` family of functions. +the xref:nng_dialer_setopt.3.adoc[`nng_dialer_setopt()`] family of functions. Once it is fully configured, the dialer may be started using the -`<<nng_dialer_start.3#,nng_dialer_start()>>` function. +xref:nng_dialer_start.3.adoc[`nng_dialer_start()`] function. TIP: If no specific configuration is required, consider using the -simpler `<<nng_dial.3#,nng_dial()>>` function instead. +simpler xref:nng_dial.3.adoc[`nng_dial()`] function instead. == RETURN VALUES @@ -69,12 +69,12 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dial.3#,nng_dial(3)>>, -<<nng_dialer_close.3#,nng_dialer_close(3)>>, -<<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>, -<<nng_dialer_setopt.3#,nng_dialer_setopt(3)>>, -<<nng_dialer_start.3#,nng_dialer_start(3)>>, -<<nng_listener_create.3#,nng_listener_create(3)>> -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dial.3.adoc[nng_dial(3)], +xref:nng_dialer_close.3.adoc[nng_dialer_close(3)], +xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt(3)], +xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(3)], +xref:nng_dialer_start.3.adoc[nng_dialer_start(3)], +xref:nng_listener_create.3.adoc[nng_listener_create(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer_get.3.adoc b/docs/man/nng_dialer_get.3.adoc index 86fec260..29acb811 100644 --- a/docs/man/nng_dialer_get.3.adoc +++ b/docs/man/nng_dialer_get.3.adoc @@ -43,9 +43,9 @@ int nng_dialer_get_uint64(nng_dialer d, const char *opt, uint64_t *u64p); (((options, dialer))) The `nng_dialer_get()` functions are used to retrieve option values for -the <<nng_dialer.5#,dialer>> _d_. +the xref:nng_dialer.5.adoc[dialer] _d_. The actual options that may be retrieved in this way -vary, and many are documented in <<nng_options.5#,nng_options(5)>>. +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_dialer_get_ms()`:: -This function is used to retrieve time <<nng_duration.5#,durations>> +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.) @@ -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_dialer_get_addr()`:: -This function is used to retrieve an `<<nng_sockaddr.5#,nng_sockaddr>>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into the value referenced by _sap_. `nng_dialer_get_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_dialer_get_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -135,13 +135,13 @@ These functions returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_dialer_set.3#,nng_dialer_set(3)>> -<<nng_strdup.3#,nng_strdup(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_strfree.3#,nng_strfree(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_sockaddr.5#,nng_sockaddr(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_dialer_set.3.adoc[nng_dialer_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_dialer.5.adoc[nng_dialer(5)], +xref:nng_duration.5.adoc[nng_duration(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_dialer_getopt.3.adoc b/docs/man/nng_dialer_getopt.3.adoc index ea7529dc..4f8b3a3e 100644 --- a/docs/man/nng_dialer_getopt.3.adoc +++ b/docs/man/nng_dialer_getopt.3.adoc @@ -45,9 +45,9 @@ NOTE: These functions are deprecated. Please see xref:nng_dialer_get.3.adoc[nng (((options, dialer))) The `nng_dialer_getopt()` functions are used to retrieve option values for -the <<nng_dialer.5#,dialer>> _d_. +the xref:nng_dialer.5.adoc[dialer] _d_. The actual options that may be retrieved in this way -vary, and many are documented in <<nng_options.5#,nng_options(5)>>. +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_dialer_getopt_ms()`:: -This function is used to retrieve time <<nng_duration.5#,durations>> +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.) @@ -105,14 +105,14 @@ This function is used to retrieve a size into the pointer _zp_, typically for buffer sizes, message maximum sizes, and similar options. `nng_dialer_getopt_sockaddr()`:: -This function is used to retrieve an `<<nng_sockaddr.5#,nng_sockaddr>>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into the value referenced by _sap_. `nng_dialer_getopt_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_dialer_getopt_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -137,13 +137,13 @@ These functions returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_dialer_setopt.3#,nng_dialer_setopt(3)>> -<<nng_strdup.3#,nng_strdup(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_strfree.3#,nng_strfree(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_sockaddr.5#,nng_sockaddr(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(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_dialer.5.adoc[nng_dialer(5)], +xref:nng_duration.5.adoc[nng_duration(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_dialer_id.3.adoc b/docs/man/nng_dialer_id.3.adoc index 029a8b47..e9643109 100644 --- a/docs/man/nng_dialer_id.3.adoc +++ b/docs/man/nng_dialer_id.3.adoc @@ -29,11 +29,11 @@ if it is valid. Otherwise it returns `-1`. NOTE: A dialer is considered valid if it was ever created with the -`<<nng_dialer_create.3#,nng_dialer_create()>>` or -`<<nng_dial.3#,nng_dial()>>` functions. +xref:nng_dialer_create.3.adoc[`nng_dialer_create()`] or +xref:nng_dial.3.adoc[`nng_dial()`] functions. Dialers that are allocated on the stack or statically should be initialized with the macro -`<<nng_ctx.5#NNG_DIALER_INITIALIZER,NNG_DIALER_INITIALIZER>>` to ensure that +xref:nng_ctx.5.adoc#NNG_DIALER_INITIALIZER[`NNG_DIALER_INITIALIZER`] to ensure that they cannot be confused with a valid dialer before they are created properly. == RETURN VALUES @@ -48,5 +48,5 @@ None. == SEE ALSO [.text-left] -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer_set.3.adoc b/docs/man/nng_dialer_set.3.adoc index 5f81e9a0..76f20e6c 100644 --- a/docs/man/nng_dialer_set.3.adoc +++ b/docs/man/nng_dialer_set.3.adoc @@ -42,9 +42,9 @@ int nng_dialer_set_uint64(nng_dialer d, const char *opt, uint64_t u64); (((options, dialer))) The `nng_dialer_set()` functions are used to configure options for -the <<nng_dialer.5#,dialer>> _d_. +the xref:nng_dialer.5.adoc[dialer] _d_. The actual options that may be configured in this way -vary, and many are documented in <<nng_options.5#,nng_options(5)>>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options are documented with the transports themselves. @@ -76,14 +76,14 @@ The _ival_ is passed to the option. `nng_dialer_set_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<<nng_duration.5#,nng_duration>>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_dialer_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 -(`<<nng_tls_config_alloc.3tls#,nng_tls_config_alloc()>>`) +(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,10 +122,10 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_dialer_get.3#,nng_dialer_get(3)>> -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_dialer_get.3.adoc[nng_dialer_get(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer_setopt.3.adoc b/docs/man/nng_dialer_setopt.3.adoc index 1e96d4de..a554acb5 100644 --- a/docs/man/nng_dialer_setopt.3.adoc +++ b/docs/man/nng_dialer_setopt.3.adoc @@ -44,9 +44,9 @@ NOTE: These functions are deprecated. Please see xref:nng_dialer_set.3.adoc[nng (((options, dialer))) The `nng_dialer_setopt()` functions are used to configure options for -the <<nng_dialer.5#,dialer>> _d_. +the xref:nng_dialer.5.adoc[dialer] _d_. The actual options that may be configured in this way -vary, and many are documented in <<nng_options.5#,nng_options(5)>>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options are documented with the transports themselves. @@ -78,14 +78,14 @@ The _ival_ is passed to the option. `nng_dialer_setopt_ms()`:: This function is used to configure time durations (such as timeouts) using -type `<<nng_duration.5#,nng_duration>>`. +type xref:nng_duration.5.adoc[`nng_duration`]. The duration _dur_ is an integer number of milliseconds. `nng_dialer_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 -(`<<nng_tls_config_alloc.3tls#,nng_tls_config_alloc()>>`) +(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,10 +124,10 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_dialer_getopt.3#,nng_dialer_getopt(3)>> -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_dialer_start.3.adoc b/docs/man/nng_dialer_start.3.adoc index 6a333543..b6cb6e89 100644 --- a/docs/man/nng_dialer_start.3.adoc +++ b/docs/man/nng_dialer_start.3.adoc @@ -70,8 +70,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dial.3#,nng_dial(3)>>, -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dial.3.adoc[nng_dial(3)], +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_dialer.5.adoc[nng_dialer(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_duration.5.adoc b/docs/man/nng_duration.5.adoc index 9d0b075a..fbd172b9 100644 --- a/docs/man/nng_duration.5.adoc +++ b/docs/man/nng_duration.5.adoc @@ -46,5 +46,5 @@ Zero length duration; used to perform a single polling operation. == SEE ALSO [.text-left] -<<nng_options.5#,nng_options(5)>>, -<<nng.7#,nng(7)>> +xref:nng_options.5.adoc[nng_options(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_free.3.adoc b/docs/man/nng_free.3.adoc index d09f3a22..b4fdc249 100644 --- a/docs/man/nng_free.3.adoc +++ b/docs/man/nng_free.3.adoc @@ -25,8 +25,8 @@ void nng_free(void *ptr, size_t size); == DESCRIPTION The `nng_free()` function deallocates a memory region of size _size_, -that was previously allocated by `<<nng_alloc.3#,nng_alloc()>>` or -`<<nng_recv.3#,nng_recv()>>` with the `NNG_FLAG_ALLOC` flag. +that was previously allocated by xref:nng_alloc.3.adoc[`nng_alloc()`] or +xref:nng_recv.3.adoc[`nng_recv()`] with the `NNG_FLAG_ALLOC` flag. IMPORTANT: It is very important that _size_ match the allocation size used to allocate the memory. @@ -48,6 +48,6 @@ None. == SEE ALSO [.text-left] -<<nng_alloc.3#,nng_alloc(3)>>, -<<nng_recv.3#,nng_recv(3)>>, -<<nng.7#,nng(7)>> +xref:nng_alloc.3.adoc[nng_alloc(3)], +xref:nng_recv.3.adoc[nng_recv(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_getopt.3.adoc b/docs/man/nng_getopt.3.adoc index 3b52b348..de3e882f 100644 --- a/docs/man/nng_getopt.3.adoc +++ b/docs/man/nng_getopt.3.adoc @@ -43,9 +43,9 @@ NOTE: These functions are deprecated. Please see xref:nng_socket_get.3.adoc[nng (((options, socket))) The `nng_getopt()` functions are used to retrieve option values for -the <<nng_socket.5#,socket>> _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 <<nng_options.5#,nng_options(5)>>. +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_getopt_ms()`:: -This function is used to retrieve time <<nng_duration.5#,durations>> +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_getopt_string()`:: This function is used to retrieve a string into _strp_. -This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>` +This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`] and consequently must be freed by the caller using -`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed. +xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed. `nng_getopt_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] -<<nng_dialer_getopt.3#,nng_dialer_getopt(3)>>, -<<nng_listener_getopt.3#,nng_listener_getopt(3)>>, -<<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>, -<<nng_setopt.3#,nng_setopt(3)>>, -<<nng_strdup.3#,nng_strdup(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_strfree.3#,nng_strfree(3)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt(3)], +xref:nng_listener_getopt.3.adoc[nng_listener_getopt(3)], +xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt(3)], +xref:nng_setopt.3.adoc[nng_setopt(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_http_client_alloc.3http.adoc b/docs/man/nng_http_client_alloc.3http.adoc index d1e96514..f433001a 100644 --- a/docs/man/nng_http_client_alloc.3http.adoc +++ b/docs/man/nng_http_client_alloc.3http.adoc @@ -42,8 +42,8 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, -<<nng_http_client_free.3http#,nng_http_client_free(3http)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_url_parse.3#,nng_url_parse(3)>>, -<<nng.7#,nng(7)>> +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_free.3http.adoc[nng_http_client_free(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_url_parse.3.adoc[nng_url_parse(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_client_connect.3http.adoc b/docs/man/nng_http_client_connect.3http.adoc index aea16746..e2a3e23c 100644 --- a/docs/man/nng_http_client_connect.3http.adoc +++ b/docs/man/nng_http_client_connect.3http.adoc @@ -31,12 +31,12 @@ _client_ was configured with. The result of the operation will be stored in the _aio_ when the operation is complete, and will be obtainable via -`<<nng_aio_result.3#,nng_aio_result()>>`. +xref:nng_aio_result.3.adoc[`nng_aio_result()`]. On success, a pointer to the underlying HTTP client (type `nng_http_conn *`) will be stored in the first output result of the _aio_, and can be obtained by -`<<nng_aio_get_output.3#,nng_aio_get_output()>>` with an _index_ of zero (0). +xref:nng_aio_get_output.3.adoc[`nng_aio_get_output()`] with an _index_ of zero (0). == RETURN VALUES @@ -87,12 +87,12 @@ None. == SEE ALSO [.text-left] -<<nng_aio_get_output.3#,nng_aio_get_output(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio_wait.3#,nng_aio_wait(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_http_client_alloc.3http#,nng_http_client_alloc(3http)>>, -<<nng_http_conn_close.3http#,nng_http_conn_close(3http)>>, -<<nng_http_conn_read.3http#,nng_http_conn_read(3http)>>, -<<nng_http_conn_write.3http#,nng_http_conn_write(3http)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_wait.3.adoc[nng_aio_wait(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_http_client_alloc.3http.adoc[nng_http_client_alloc(3http)], +xref:nng_http_conn_close.3http.adoc[nng_http_conn_close(3http)], +xref:nng_http_conn_read.3http.adoc[nng_http_conn_read(3http)], +xref:nng_http_conn_write.3http.adoc[nng_http_conn_write(3http)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_client_free.3http.adoc b/docs/man/nng_http_client_free.3http.adoc index 80b99a6a..2343672c 100644 --- a/docs/man/nng_http_client_free.3http.adoc +++ b/docs/man/nng_http_client_free.3http.adoc @@ -29,7 +29,7 @@ The `nng_http_client_free()` frees the HTTP client and any associated resources referenced by _client_. NOTE: Any connections created by -`<<nng_http_client_connect.3http#,nng_http_client_connect()>>` are unaffected, +xref:nng_http_client_connect.3http.adoc[`nng_http_client_connect()`] are unaffected, and so the caller must close those explicitly if desired. == RETURN VALUES @@ -43,6 +43,6 @@ None. == SEE ALSO [.text-left] -<<nng_http_client_alloc.3http#,nng_http_client_alloc(3)>>, -<<nng_http_client_connect.3http#,nng_http_client_connect(3)>>, -<<nng.7#,nng(7)>> +xref:nng_http_client_alloc.3http.adoc[nng_http_client_alloc(3)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_http_client_get_tls.3http.adoc b/docs/man/nng_http_client_get_tls.3http.adoc index 53e4f426..89f03029 100644 --- a/docs/man/nng_http_client_get_tls.3http.adoc +++ b/docs/man/nng_http_client_get_tls.3http.adoc @@ -29,10 +29,10 @@ The `nng_http_client_get_tls()` obtains the TLS configuration of _client_ and saves a pointer to it in the address referenced by _cfgp_. The object will be returned with an extra hold (see -`<<nng_tls_config_hold.3tls#,nng_tls_config_hold()>>`) +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 -`<<nng_tls_config_free.3tls#,nng_tls_config_free()>>` 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] -<<nng_http_client_alloc.3http#,nng_http_client_alloc(3http)>>, -<<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, -<<nng_http_client_set_tls.3http#,nng_http_client_set_tls(3http)>>, -<<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, -<<nng_tls_config_free.3tls#,nng_tls_config_free(3tls)>>, -<<nng_tls_config_hold.3tls#,nng_tls_config_hold(3tls)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_http_client_alloc.3http.adoc[nng_http_client_alloc(3http)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_set_tls.3http.adoc[nng_http_client_set_tls(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_client_set_tls.3http.adoc b/docs/man/nng_http_client_set_tls.3http.adoc index 0a00d138..023b8a4e 100644 --- a/docs/man/nng_http_client_set_tls.3http.adoc +++ b/docs/man/nng_http_client_set_tls.3http.adoc @@ -30,10 +30,10 @@ The `nng_http_client_set_tls()` sets the TLS configuration of _client_ to _cfg_. This change overwrites any previous TLS configuration. IMPORTANT: This also invalidates any previously obtained values from -`<<nng_http_client_get_tls.3http#,nng_http_client_get_tls()>>`. +xref:nng_http_client_get_tls.3http.adoc[`nng_http_client_get_tls()`]. NOTE: Any connections established with -`<<nng_http_client_connect.3http#,nng_http_client_connect()>>` +xref:nng_http_client_connect.3http.adoc[`nng_http_client_connect()`] will continue to use any TLS configuration that they were started with. == RETURN VALUES @@ -49,9 +49,9 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_http_client_alloc.3http#,nng_http_client_alloc(3http)>>, -<<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, -<<nng_http_client_get_tls.3http#,nng_http_client_get_tls(3http)>>, -<<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_http_client_alloc.3http.adoc[nng_http_client_alloc(3http)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_client_get_tls.3http.adoc[nng_http_client_get_tls(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_client_transact.3http.adoc b/docs/man/nng_http_client_transact.3http.adoc index a469dc50..be65c2c0 100644 --- a/docs/man/nng_http_client_transact.3http.adoc +++ b/docs/man/nng_http_client_transact.3http.adoc @@ -34,14 +34,14 @@ sending the request _req_ _res_, and finally closes the connection that it created. The entire response is read, including any associated body, which can subsequently be obtained using -`<<nng_http_res_get_data.3http#,nng_http_res_get_data()>>`. +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. A similar function, -`<<nng_http_conn_transact.3http#,nng_http_conn_transact()>>`, +xref:nng_http_conn_transact.3http.adoc[`nng_http_conn_transact()`], exists. That function behaves similarily, but uses an existing connection, which can be reused. @@ -59,7 +59,7 @@ trust-worthy servers. 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 `<<nng_aio_result.3#,nng_aio_result()>>`. +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 @@ -80,10 +80,10 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, -<<nng_http_conn_transact.3http#,nng_http_conn_transact(3http)>>, -<<nng_http_res_get_data.3http#,nng_http_res_get_data(3http)>>, -<<nng.7#,nng(7)>> +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_transact.3http.adoc[nng_http_conn_transact(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_msleep.3supp.adoc b/docs/man/nng_msleep.3supp.adoc index c1e3ff64..57d3615b 100644 --- a/docs/man/nng_msleep.3supp.adoc +++ b/docs/man/nng_msleep.3supp.adoc @@ -42,8 +42,8 @@ None. == SEE ALSO [.text-left] -<<nng_sleep_aio.3#,nng_sleep_aio(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_clock.3supp#,nng_clock(3supp)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng.7#,nng(7)>> +xref:nng_sleep_aio.3.adoc[nng_sleep_aio(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_clock.3supp.adoc[nng_clock(3supp)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_url_clone.3.adoc b/docs/man/nng_url_clone.3.adoc index e201b7a9..b77f316f 100644 --- a/docs/man/nng_url_clone.3.adoc +++ b/docs/man/nng_url_clone.3.adoc @@ -40,7 +40,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_url_free.3#,nng_url_free(3)>>, -<<nng_url_parse.3#,nng_url_parse(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_url_free.3.adoc[nng_url_free(3)], +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_url_free.3.adoc b/docs/man/nng_url_free.3.adoc index 3e49f5d6..208a584c 100644 --- a/docs/man/nng_url_free.3.adoc +++ b/docs/man/nng_url_free.3.adoc @@ -38,6 +38,6 @@ None. == SEE ALSO [.text-left] -<<nng_url_clone.3#,nng_url_clone(3)>>, -<<nng_url_parse.3#,nng_url_parse(3)>>, -<<nng.7#,nng(7)>> +xref:nng_url_clone.3.adoc[nng_url_clone(3)], +xref:nng_url_parse.3.adoc[nng_url_parse(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_url_parse.3.adoc b/docs/man/nng_url_parse.3.adoc index 0cce5d2e..10ca695f 100644 --- a/docs/man/nng_url_parse.3.adoc +++ b/docs/man/nng_url_parse.3.adoc @@ -90,7 +90,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_url_clone.3#,nng_url_clone(3)>>, -<<nng_url_free.3#,nng_url_free(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_url_clone.3.adoc[nng_url_clone(3)], +xref:nng_url_free.3.adoc[nng_url_free(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_version.3.adoc b/docs/man/nng_version.3.adoc index 1c52d5e8..13c975b5 100644 --- a/docs/man/nng_version.3.adoc +++ b/docs/man/nng_version.3.adoc @@ -54,5 +54,5 @@ None. == SEE ALSO [.text-left] -<<libnng.3#,libnng(3)>>, -<<nng.7#,nng(7)>> +xref:libnng.3.adoc[libnng(3)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ws_register.3.adoc b/docs/man/nng_ws_register.3.adoc index 54dc154d..a5f09d97 100644 --- a/docs/man/nng_ws_register.3.adoc +++ b/docs/man/nng_ws_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ws.7#,nng_ws(7)>>, -<<nng.7#,nng(7)>> +xref:nng_ws.7.adoc[nng_ws(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_wss_register.3.adoc b/docs/man/nng_wss_register.3.adoc index 0b485429..14f434d6 100644 --- a/docs/man/nng_wss_register.3.adoc +++ b/docs/man/nng_wss_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_ws.7#,nng_ws(7)>>, -<<nng.7#,nng(7)>> +xref:nng_ws.7.adoc[nng_ws(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc index 4d7bb804..e3cc4060 100644 --- a/docs/man/nng_zt_register.3.adoc +++ b/docs/man/nng_zt_register.3.adoc @@ -40,5 +40,5 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_zerotier.7#,nng_zerotier(7)>>, -<<nng.7#,nng(7)>> +xref:nng_zerotier.7.adoc[nng_zerotier(7)], +xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nngcat.1.adoc b/docs/man/nngcat.1.adoc index 2b895471..f7850d34 100644 --- a/docs/man/nngcat.1.adoc +++ b/docs/man/nngcat.1.adoc @@ -71,11 +71,11 @@ each option must be presented as a separate argument to the program. _nanocat_ application. In this mode connections are made asynchronously, and the *--pair* option selects version 0 of - the <<nng_pair.7#,_pair_>> protocol instead of version 1. + the xref:nng_pair.7.adoc[_pair_] protocol instead of version 1. *--subscribe*=_TOPIC_:: Subscribe to _TOPIC_. This option can only be used with the - <<nng_sub.7#,_sub_>> protocol. + xref:nng_sub.7.adoc[_sub_] protocol. The _TOPIC_ is checked against the first bytes of messages received, and messages are discarded if they do not match. This may be specified multiple times to subscribe to multiple topics. @@ -96,46 +96,46 @@ each option must be presented as a separate argument to the program. NOTE: At least one protocol must be selected. *--bus, --bus0*:: - Select the <<nng_bus.7#,_bus_>> version 0 protocol. + Select the xref:nng_bus.7.adoc[_bus_] version 0 protocol. This protocol can send and receive messages to and from other _bus_ version 0 peers. *--req, --req0*:: - Select the <<nng_req.7#,_req_>> version 0 protocol. - This protocol sends messages to <<nng_rep.7#,_rep_>> version 0 + Select the xref:nng_req.7.adoc[_req_] version 0 protocol. + This protocol sends messages to xref:nng_rep.7.adoc[_rep_] version 0 peers and receives replies from them. *--rep, --rep0*:: - Select the <<nng_rep.7#,_rep_>> version 0 protocol. - This protocol receives messages from <<nng_req.7#,_req_>> version 0 peers + Select the xref:nng_rep.7.adoc[_rep_] version 0 protocol. + This protocol receives messages from xref:nng_req.7.adoc[_req_] version 0 peers and can send replies to them. *--pub, --pub0*:: - Select the <<nng_pub.7#,_pub_>> version 0 protocol. - This protocol sends messages to <<nng_sub.7#,_sub_>> version peers. + Select the xref:nng_pub.7.adoc[_pub_] version 0 protocol. + This protocol sends messages to xref:nng_sub.7.adoc[_sub_] version peers. *--sub, --sub0*:: - Select the <<nng_sub.7#,_sub_>> version 0 protocol. - This protocol receives messages from <<nng_pub.7#,_pub_>> version + Select the xref:nng_sub.7.adoc[_sub_] version 0 protocol. + This protocol receives messages from xref:nng_pub.7.adoc[_pub_] version 0 peers, and filters them based on subscriptions set with *--subscribe*. *--push, --push0*:: - Select the <<nng_push.7#,_push_>> version 0 protocol. - This protocol sends messages to <<nng_pull.7#,_pull_>> version 0 peers. + Select the xref:nng_push.7.adoc[_push_] version 0 protocol. + This protocol sends messages to xref:nng_pull.7.adoc[_pull_] version 0 peers. A given message is normally only delivered to a single peer. *--pull, --pull0*:: - Select the <<nng_pull.7#,_pull_>> version 0 protocol. + Select the xref:nng_pull.7.adoc[_pull_] version 0 protocol. This protocol receives - messages from <<nng_push.7#,_push_>> version 0 peers. + messages from xref:nng_push.7.adoc[_push_] version 0 peers. *--pair0*:: - Select the <<nng_pair.7#,_pair_>> version 0 protocol. + Select the xref:nng_pair.7.adoc[_pair_] version 0 protocol. This protocol can send and receive messages with one connected _pair_ version 0 peer. *--pair1*:: - Select the <<nng_pair.7#,_pair_>> version 1 protocol. + Select the xref:nng_pair.7.adoc[_pair_] version 1 protocol. This protocol can send and receive messages with one connected _pair_ version 1 peer. It is not supported in *--compat* mode. @@ -147,13 +147,13 @@ NOTE: At least one protocol must be selected. which case it acts as an alias for *--pair0*. *--surveyor, --surveyor0*:: - Select the <<nng_surveyor.7#,_surveyor_>> version 0 protocol. - This protocol sends a survey request to <<nng_respondent.7#,_respondent_>> + Select the xref:nng_surveyor.7.adoc[_surveyor_] version 0 protocol. + This protocol sends a survey request to xref:nng_respondent.7.adoc[_respondent_] version 0 peers, and then receives replies from them. *--respondent, --respondent0*:: - Select the <<nng_respondent.7#,_respondent_>> version 0 protocol. - This protocol receives survey requests from <<nng_surveyor.7#,_surveyor_>> + Select the xref:nng_respondent.7.adoc[_respondent_] version 0 protocol. + This protocol receives survey requests from xref:nng_surveyor.7.adoc[_surveyor_] version 0 peers, and can send a reply to them. === Peer Selection Options @@ -314,15 +314,15 @@ $ nngcat --sub --dial=${addr} --quoted & == SEE ALSO [.text-left] -<<libnng.3#,libnng(3)>>, -<<nng.7#,nng(7)>>, -<<nng_bus.7#,nng_bus(7)>>, -<<nng_pair.7#,nng_pair(7)>>, -<<nng_pub.7#,nng_pub(7)>>, -<<nng_pull.7#,nng_pull(7)>>, -<<nng_push.7#,nng_push(7)>>, -<<nng_sub.7#,nng_sub(7)>>, -<<nng_rep.7#,nng_rep(7)>>, -<<nng_req.7#,nng_req(7)>>, -<<nng_respondent.7#,nng_respondent(7)>>, -<<nng_surveyor.7#,nng_surveyor(7)>> +xref:libnng.3.adoc[libnng(3)], +xref:nng.7.adoc[nng(7)], +xref:nng_bus.7.adoc[nng_bus(7)], +xref:nng_pair.7.adoc[nng_pair(7)], +xref:nng_pub.7.adoc[nng_pub(7)], +xref:nng_pull.7.adoc[nng_pull(7)], +xref:nng_push.7.adoc[nng_push(7)], +xref:nng_sub.7.adoc[nng_sub(7)], +xref:nng_rep.7.adoc[nng_rep(7)], +xref:nng_req.7.adoc[nng_req(7)], +xref:nng_respondent.7.adoc[nng_respondent(7)], +xref:nng_surveyor.7.adoc[nng_surveyor(7)] |
