diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-30 20:44:29 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-30 20:44:29 -0700 |
| commit | 0974ccc48f80ed4cf29ace7255341c2c1284f448 (patch) | |
| tree | 1329f7c181fe1461af0b4b53e42f154120ead3b0 /docs/reference/src | |
| parent | 548ab684fa83f3098dea4e7ce09d3f4f1bdb7358 (diff) | |
| download | nng-0974ccc48f80ed4cf29ace7255341c2c1284f448.tar.gz nng-0974ccc48f80ed4cf29ace7255341c2c1284f448.tar.bz2 nng-0974ccc48f80ed4cf29ace7255341c2c1284f448.zip | |
Aio moved
Diffstat (limited to 'docs/reference/src')
| -rw-r--r-- | docs/reference/src/SUMMARY.md | 34 | ||||
| -rw-r--r-- | docs/reference/src/aio/index.md (renamed from docs/reference/src/api/aio/index.md) | 46 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_abort.md (renamed from docs/reference/src/api/aio/nng_aio_abort.md) | 10 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_alloc.md (renamed from docs/reference/src/api/aio/nng_aio_alloc.md) | 39 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_busy.md (renamed from docs/reference/src/api/aio/nng_aio_busy.md) | 10 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_cancel.md (renamed from docs/reference/src/api/aio/nng_aio_cancel.md) | 12 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_count.md (renamed from docs/reference/src/api/aio/nng_aio_count.md) | 14 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_free.md (renamed from docs/reference/src/api/aio/nng_aio_free.md) | 8 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_get_msg.md (renamed from docs/reference/src/api/aio/nng_aio_get_msg.md) | 12 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_get_output.md (renamed from docs/reference/src/api/aio/nng_aio_get_output.md) | 6 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_result.md (renamed from docs/reference/src/api/aio/nng_aio_result.md) | 10 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_set_input.md (renamed from docs/reference/src/api/aio/nng_aio_set_input.md) | 8 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_set_iov.md (renamed from docs/reference/src/api/aio/nng_aio_set_iov.md) | 4 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_set_msg.md (renamed from docs/reference/src/api/aio/nng_aio_set_msg.md) | 10 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_set_timeout.md (renamed from docs/reference/src/api/aio/nng_aio_set_timeout.md) | 12 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_stop.md (renamed from docs/reference/src/api/aio/nng_aio_stop.md) | 13 | ||||
| -rw-r--r-- | docs/reference/src/aio/nng_aio_wait.md (renamed from docs/reference/src/api/aio/nng_aio_wait.md) | 8 | ||||
| -rw-r--r-- | docs/reference/src/api/context.md | 1 | ||||
| -rw-r--r-- | docs/reference/src/chapter_1.md | 1 | ||||
| -rw-r--r-- | docs/reference/src/refs.md | 18 |
20 files changed, 161 insertions, 115 deletions
diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md index 4816be30..48fdc8df 100644 --- a/docs/reference/src/SUMMARY.md +++ b/docs/reference/src/SUMMARY.md @@ -69,23 +69,23 @@ - [nng_ctx_set](ctx/nng_ctx_set.md) - [nng_ctx_setopt](ctx/nng_ctx_setopt.md) - - [Asynchronous I/O](./api/aio/index.md) - - - [nng_aio_abort](api/aio/nng_aio_abort.md) - - [nng_aio_alloc](api/aio/nng_aio_alloc.md) - - [nng_aio_busy](api/aio/nng_aio_busy.md) - - [nng_aio_cancel](api/aio/nng_aio_cancel.md) - - [nng_aio_count](api/aio/nng_aio_count.md) - - [nng_aio_free](api/aio/nng_aio_free.md) - - [nng_aio_get_msg](api/aio/nng_aio_get_msg.md) - - [nng_aio_get_output](api/aio/nng_aio_get_output.md) - - [nng_aio_result](api/aio/nng_aio_result.md) - - [nng_aio_set_input](api/aio/nng_aio_set_input.md) - - [nng_aio_set_iov](api/aio/nng_aio_set_iov.md) - - [nng_aio_set_msg](api/aio/nng_aio_set_msg.md) - - [nng_aio_set_timeout](api/aio/nng_aio_set_timeout.md) - - [nng_aio_stop](api/aio/nng_aio_stop.md) - - [nng_aio_wait](api/aio/nng_aio_wait.md) + - [Asynchronous I/O](aio/index.md) + + - [nng_aio_abort](aio/nng_aio_abort.md) + - [nng_aio_alloc](aio/nng_aio_alloc.md) + - [nng_aio_busy](aio/nng_aio_busy.md) + - [nng_aio_cancel](aio/nng_aio_cancel.md) + - [nng_aio_count](aio/nng_aio_count.md) + - [nng_aio_free](aio/nng_aio_free.md) + - [nng_aio_get_msg](aio/nng_aio_get_msg.md) + - [nng_aio_get_output](aio/nng_aio_get_output.md) + - [nng_aio_result](aio/nng_aio_result.md) + - [nng_aio_set_input](aio/nng_aio_set_input.md) + - [nng_aio_set_iov](aio/nng_aio_set_iov.md) + - [nng_aio_set_msg](aio/nng_aio_set_msg.md) + - [nng_aio_set_timeout](aio/nng_aio_set_timeout.md) + - [nng_aio_stop](aio/nng_aio_stop.md) + - [nng_aio_wait](aio/nng_aio_wait.md) - [Asynchronous I/O for Providers](api/aio_provider/index.md) diff --git a/docs/reference/src/api/aio/index.md b/docs/reference/src/aio/index.md index 84c6d6e1..665a91e3 100644 --- a/docs/reference/src/api/aio/index.md +++ b/docs/reference/src/aio/index.md @@ -13,8 +13,8 @@ Applications create an `nng_aio` object with a function to call when the operation is done (along with a pointer to application private data), then submit the operation. -These `nng_aio` objects are created using the [`nng_aio_alloc()`](nng_aio_alloc.md), -and destroyed using [`nng_aio_free()`](nng_aio_free.md). +These `nng_aio` objects are created using the [`nng_aio_alloc()`][nng_aio_alloc], +and destroyed using [`nng_aio_free()`][nng_aio_free]. The `nng_aio` object itself is declared like this: @@ -41,34 +41,36 @@ The callback will be executed exactly once. The asynchronous I/O framework also supports cancellation of operations that are already in progress -(see [`nng_aio_cancel()`](nng_aio_cancel.md)), as well setting a maximum +(see [`nng_aio_cancel()`][nng_aio_cancel]), as well setting a maximum timeout for them to complete within -(see [`nng_aio_set_timeout()`](nng_aio_set_timeout.md)). +(see [`nng_aio_set_timeout()`][nng_aio_set_timeout]). ## Waiting for Completion It is also possible to initiate an asynchronous operation, and wait for it to -complete [`nng_aio_wait()`](nng_aio_wait.md). +complete [`nng_aio_wait()`][nng_aio_wait]. > [!IMPORTANT] -> Applications must never call [`nng_aio_wait()`](nng_aio_wait.md) or -> [`nng_aio_stop()`](nng_aio_stop.md) from a callback registered to +> Applications must never call [`nng_aio_wait()`][nng_aio_wait] or +> [`nng_aio_stop()`][nng_aio_stop] from a callback registered to > an `nng_aio` object. Doing so can lead to a deadlock. ## See Also -[nng_aio_abort](nng_aio_abort.md), -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_cancel](nng_aio_cancel.md), -[nng_aio_count](nng_aio_count.md), -[nng_aio_free](nng_aio_free.md), -[nng_aio_get_input](nng_aio_get_input.md), -[nng_aio_get_msg](nng_aio_get_msg.md), -[nng_aio_get_output](nng_aio_get_output.md), -[nng_aio_result](nng_aio_result.md), -[nng_aio_set_input](nng_aio_set_input.md), -[nng_aio_set_iov](nng_aio_set_iov.md), -[nng_aio_set_msg](nng_aio_set_msg.md), -[nng_aio_set_timeout](nng_aio_set_timeout.md), -[nng_aio_stop](nng_aio_stop.md), -[nng_aio_wait](nng_aio_wait.md) +[nng_aio_abort][nng_aio_abort], +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_count][nng_aio_count], +[nng_aio_free][nng_aio_free], +[nng_aio_get_input][nng_aio_get_input], +[nng_aio_get_msg][nng_aio_get_msg], +[nng_aio_get_output][nng_aio_get_output], +[nng_aio_result][nng_aio_result], +[nng_aio_set_input][nng_aio_set_input], +[nng_aio_set_iov][nng_aio_set_iov], +[nng_aio_set_msg][nng_aio_set_msg], +[nng_aio_set_timeout][nng_aio_set_timeout], +[nng_aio_stop][nng_aio_stop], +[nng_aio_wait][nng_aio_wait] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_abort.md b/docs/reference/src/aio/nng_aio_abort.md index a94ffd30..74804a5c 100644 --- a/docs/reference/src/api/aio/nng_aio_abort.md +++ b/docs/reference/src/aio/nng_aio_abort.md @@ -18,7 +18,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()`](nng_aio_result.md) +[`nng_aio_result()`][nng_aio_result] will return the error _err_. This function does not wait for the operation to be fully aborted, but @@ -30,6 +30,8 @@ has no effect. ## SEE ALSO -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_cancel](nng_aio_cancel.md), -[nng_aio_result](nng_aio_result.md) +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_result][nng_aio_result] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_alloc.md b/docs/reference/src/aio/nng_aio_alloc.md index 5636f398..988f4bf2 100644 --- a/docs/reference/src/api/aio/nng_aio_alloc.md +++ b/docs/reference/src/aio/nng_aio_alloc.md @@ -29,7 +29,7 @@ It will be called with the argument _arg_. > [!TIP] > If more complex or blocking work needs to be performed by _callb_, a separate -> thread can be used, along with a [condition variable](nng_cv_alloc.md) +> thread can be used, along with a [condition variable][nng_cv_alloc] > which can be signaled by the callback. Asynchronous I/O operations all take an [`nng_aio`](index.md) @@ -38,15 +38,15 @@ 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()`](nng_aio_result.md), [`nng_aio_count()`](nng_aio_count.md), -and [`nng_aio_get_output()`](nng_aio_get_output.md). +[`nng_aio_result()`][nng_aio_result], [`nng_aio_count()`][nng_aio_count], +and [`nng_aio_get_output()`][nng_aio_get_output]. It is possible to wait synchronously for an otherwise asynchronous operation -by using the function [`nng_aio_wait()`](nng_aio_wait.md). +by using the function [`nng_aio_wait()`][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()`](nng_aio_wait.md). +[`nng_aio_wait()`][nng_aio_wait]. ## RETURN VALUES @@ -58,17 +58,18 @@ This function returns 0 on success, and non-zero otherwise. ## SEE ALSO -[nng_aio_abort](nng_aio_abort.md), -[nng_aio_cancel](nng_aio_cancel.md), -[nng_aio_count](nng_aio_count.md), -[nng_aio_free](nng_aio_free.md), -[nng_aio_get_input](nng_aio_get_input.md), -[nng_aio_get_msg](nng_aio_get_msg.md), -[nng_aio_get_output](nng_aio_get_output.md), -[nng_aio_result](nng_aio_result.md), -[nng_aio_set_input](nng_aio_set_input.md), -[nng_aio_set_iov](nng_aio_set_iov.md), -[nng_aio_set_msg](nng_aio_set_msg.md), -[nng_aio_set_timeout](nng_aio_set_timeout.md), -[nng_aio_stop](nng_aio_stop.md), -[nng_aio_wait](nng_aio_wait.md) +[nng_aio_abort][nng_aio_abort], +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_count][nng_aio_count], +[nng_aio_free][nng_aio_free], +[nng_aio_get_msg][nng_aio_get_msg], +[nng_aio_get_output][nng_aio_get_output], +[nng_aio_result][nng_aio_result], +[nng_aio_set_input][nng_aio_set_input], +[nng_aio_set_iov][nng_aio_set_iov], +[nng_aio_set_msg][nng_aio_set_msg], +[nng_aio_set_timeout][nng_aio_set_timeout], +[nng_aio_stop][nng_aio_stop], +[nng_aio_wait][nng_aio_wait] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_busy.md b/docs/reference/src/aio/nng_aio_busy.md index 826247fa..7aef17fb 100644 --- a/docs/reference/src/api/aio/nng_aio_busy.md +++ b/docs/reference/src/aio/nng_aio_busy.md @@ -23,7 +23,7 @@ been completed or canceled, and any callback has been executed, then it returns false. This is the same test used internally by -[`nng_aio_wait()`](nng_aio_wait.md). +[`nng_aio_wait()`][nng_aio_wait]. > [!IMPORTANT] > Care should be taken to ensure that the _aio_ object is not @@ -36,6 +36,8 @@ True if the _aio_ is busy, false otherwise. ## SEE ALSO -[nng_aio_abort](nng_aio_abort.md), -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_wait](nng_aio_wait.md) +[nng_aio_abort][nng_aio_abort], +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_wait][nng_aio_wait] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_cancel.md b/docs/reference/src/aio/nng_aio_cancel.md index c523bf52..e3b53d93 100644 --- a/docs/reference/src/api/aio/nng_aio_cancel.md +++ b/docs/reference/src/aio/nng_aio_cancel.md @@ -18,7 +18,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()`](nng_aio_result.md) will return the error `NNG_ECANCELED`. +[`nng_aio_result()`][nng_aio_result] will return the error `NNG_ECANCELED`. This function does not wait for the operation to be fully aborted, but returns immediately. @@ -28,10 +28,12 @@ finished, or no operation has been started yet), then this function has no effect. This function is the same as calling -[`nng_aio_abort()`](nng_aio_abort.md) with the error `NNG_ECANCELED`. +[`nng_aio_abort()`][nng_aio_abort] with the error `NNG_ECANCELED`. ## SEE ALSO -[nng_aio_abort](nng_aio_abort.md), -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_result](nng_aio_result.md) +[nng_aio_abort][nng_aio_abort], +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_result][nng_aio_result] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_count.md b/docs/reference/src/aio/nng_aio_count.md index ae844da0..1bd06e94 100644 --- a/docs/reference/src/api/aio/nng_aio_count.md +++ b/docs/reference/src/aio/nng_aio_count.md @@ -23,14 +23,14 @@ 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()`](nng_aio_set_iov.md)). +of a scatter/gather vector (set by [`nng_aio_set_iov()`][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()`](nng_aio_wait.md). +> [`nng_aio_wait()`][nng_aio_wait]. ## RETURN VALUES @@ -38,7 +38,9 @@ The number of bytes transferred by the operation. ## SEE ALSO -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_result](nng_aio_result.md), -[nng_aio_set_iov](nng_aio_set_iov.md), -[nng_aio_wait](nng_aio_wait.md) +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_result][nng_aio_result], +[nng_aio_set_iov][nng_aio_set_iov], +[nng_aio_wait][nng_aio_wait] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_free.md b/docs/reference/src/aio/nng_aio_free.md index ba400bba..500ec2a6 100644 --- a/docs/reference/src/api/aio/nng_aio_free.md +++ b/docs/reference/src/aio/nng_aio_free.md @@ -19,7 +19,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()`](nng_aio_stop.md).) +(This is done by implicitly calling [`nng_aio_stop()`][nng_aio_stop].) The `nng_aio_reap()` function is the same as `nng_aio_free()`, but does its work in a background thread. @@ -30,5 +30,7 @@ This can be useful to discard the _aio_ object from within the callback for the ## SEE ALSO -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_stop](nng_aio_stop.md) +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_stop][nng_aio_stop] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_get_msg.md b/docs/reference/src/aio/nng_aio_get_msg.md index e77b7810..33b07981 100644 --- a/docs/reference/src/api/aio/nng_aio_get_msg.md +++ b/docs/reference/src/aio/nng_aio_get_msg.md @@ -16,15 +16,17 @@ 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()`](nng_recv_aio.md)) +(see [`nng_recv_aio()`][nng_recv_aio]) or that was previously stored with -[`nng_aio_set_msg()`](nng_aio_set_msg.md). +[`nng_aio_set_msg()`][nng_aio_set_msg]. > [!IMPORTANT] > The _aio_ must not have an operation in progress. ## SEE ALSO -[nng_aio_set_msg](nng_aio_set_msg.md), -[nng_recv_aio](nng_recv_aio.md), -[Messages](../msg/index.md) +[nng_aio_set_msg][nng_aio_set_msg], +[nng_recv_aio][nng_recv_aio], +[Messages][msg] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_get_output.md b/docs/reference/src/aio/nng_aio_get_output.md index 9983696f..a7a82f56 100644 --- a/docs/reference/src/api/aio/nng_aio_get_output.md +++ b/docs/reference/src/aio/nng_aio_get_output.md @@ -35,6 +35,8 @@ The *index*th output from the operation, or `NULL`. ## SEE ALSO -[nng_aio_alloc](nng_aio_alloc.md), +[nng_aio_alloc][nng_aio_alloc], [nng_aio_set_output](../aio_provider/nng_aio_set_output.md), -[nng_aio_result](nng_aio_result.md) +[nng_aio_result][nng_aio_result] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_result.md b/docs/reference/src/aio/nng_aio_result.md index 21038719..16cede6a 100644 --- a/docs/reference/src/api/aio/nng_aio_result.md +++ b/docs/reference/src/aio/nng_aio_result.md @@ -24,7 +24,7 @@ Otherwise a non-zero error code is returned. > 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()`](nng_aio_wait.md). +> [`nng_aio_wait()`][nng_aio_wait]. ## RETURN VALUES @@ -40,7 +40,9 @@ Various other return values are possible depending on the operation. ## SEE ALSO -[nng_aio_abort](nng_aio_abort.md), -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_wait](nng_aio_wait.md), +[nng_aio_abort][nng_aio_abort], +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_wait][nng_aio_wait], [nng_strerror](../util/nng_strerror.md) + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_set_input.md b/docs/reference/src/aio/nng_aio_set_input.md index baf9587a..d09ba05f 100644 --- a/docs/reference/src/api/aio/nng_aio_set_input.md +++ b/docs/reference/src/aio/nng_aio_set_input.md @@ -34,9 +34,11 @@ currently defined can accept more than four parameters. > in use by an active asynchronous operation. An input parameter set with this function may be retrieved later with -the [`nng_aio_get_input()`](nng_aio_get_input.md) function. +the [`nng_aio_get_input()`][nng_aio_get_input] function. ## SEE ALSO -[nng_aio_alloc](nng_aio_alloc.md), -[nng_aio_get_input](../aio_provider/nng_aio_get_input.md) +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_get_input][nng_aio_get_input] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_set_iov.md b/docs/reference/src/aio/nng_aio_set_iov.md index 0c33153d..b8f1a0b5 100644 --- a/docs/reference/src/api/aio/nng_aio_set_iov.md +++ b/docs/reference/src/aio/nng_aio_set_iov.md @@ -16,7 +16,7 @@ int nng_aio_set_iov(nng_aio *aio, unsigned int niov, nng_iov *iov); The `nng_aio_set_iov()` function sets a {{i:scatter/gather}} vector _iov_ on the handle _aio_. -The _iov_ is a pointer to an array of _niov_ [`nng_iov`](nng_iov.md) +The _iov_ is a pointer to an array of _niov_ [`nng_iov`][nng_iov] structures, which have the following definition: ```c @@ -38,3 +38,5 @@ This function returns 0 on success, and non-zero otherwise. ## ERRORS - `NNG_EINVAL`: Value of specified _niov_ is too large. + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_set_msg.md b/docs/reference/src/aio/nng_aio_set_msg.md index c9b5c03a..5b4c0e00 100644 --- a/docs/reference/src/api/aio/nng_aio_set_msg.md +++ b/docs/reference/src/aio/nng_aio_set_msg.md @@ -16,13 +16,15 @@ void nng_aio_set_msg(nng_aio *aio, nng_msg *msg); The `nng_aio_set_msg()` function sets the message that will be used for an asynchronous send operation (see -[`nng_send_aio()`](nng_send_aio.md)). +[`nng_send_aio()`][nng_send_aio]). > [!IMPORTANT] > The _aio_ must not have an operation in progress. ## SEE ALSO -[nng_aio_get_msg](nng_aio_get_msg.md), -[nng_send_aio](nng_send_aio.md), -[Messages](../msg/index.md) +[nng_aio_get_msg][nng_aio_get_msg], +[nng_send_aio][nng_send_aio], +[Messages][msg] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_set_timeout.md b/docs/reference/src/aio/nng_aio_set_timeout.md index 34daa6f4..f4b18a58 100644 --- a/docs/reference/src/api/aio/nng_aio_set_timeout.md +++ b/docs/reference/src/aio/nng_aio_set_timeout.md @@ -25,8 +25,8 @@ If the timer expires before the operation is completed, then it is aborted with an error of `NNG_ETIMEDOUT`. The _timeout_ is specified as a relative number of milliseconds. -If the timeout is `NNG_DURATION_INFINITE`, then no timeout is used. -If the timeout is `NNG_DURATION_DEFAULT`, then a "default" or socket-specific +If the timeout is {{i:`NNG_DURATION_INFINITE`}}, then no timeout is used. +If the timeout is {{i:`NNG_DURATION_DEFAULT`}}, then a "default" or socket-specific timeout is used. (This is frequently the same as `NNG_DURATION_INFINITE`.) @@ -48,6 +48,8 @@ or absolute timeout. ## SEE ALSO -[nng_aio_cancel](nng_aio_cancel.md), -[nng_aio_result](nng_aio_result.md), -[nng_clock](../util/nng_clock.md) +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_result][nng_aio_result], +[nng_clock][nng_clock] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_stop.md b/docs/reference/src/aio/nng_aio_stop.md index 7838eda2..01e328b1 100644 --- a/docs/reference/src/api/aio/nng_aio_stop.md +++ b/docs/reference/src/aio/nng_aio_stop.md @@ -20,7 +20,7 @@ for it to complete or to be completely aborted, and for the callback associated with the _aio_ to have completed executing. Further calls to -[`nng_aio_begin()`](nng_aio_begin.md) using this _aio_ will return `false`. +[`nng_aio_begin()`][nng_aio_begin] using this _aio_ will return `false`. It is safe to call this for an _aio_, even when no operation is currently pending for it. @@ -28,12 +28,13 @@ pending for it. > [!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 -> them with [`nng_aio_free()`](nng_aio_free.md), particularly if the callbacks +> them with [`nng_aio_free()`][nng_aio_free], particularly if the callbacks > might attempt to reschedule additional operations. ## SEE ALSO -[nng_aio_cancel](nng_aio_cancel.md), -[nng_aio_free](nng_aio_free.md), -[nng_aio_begin](nng_aio_begin.md), -[nng_aio_wait](nng_aio-wait.md) +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_free][nng_aio_free], +[nng_aio_wait][nng_aio_wait] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio/nng_aio_wait.md b/docs/reference/src/aio/nng_aio_wait.md index 76198ca1..f3d1e384 100644 --- a/docs/reference/src/api/aio/nng_aio_wait.md +++ b/docs/reference/src/aio/nng_aio_wait.md @@ -24,10 +24,12 @@ function will not be called until the callback has completed. > [!IMPORTANT] > This function should never be called from a function that itself -> is a callback of an [`nng_aio`](index.md), either this one or any other. +> is a callback of an [`nng_aio`][aio], either this one or any other. > Doing so may result in a deadlock. ## SEE ALSO -[nng_aio_abort](nng_aio_abort.md), -[nng_aio_busy](nng_aio_busy.md) +[nng_aio_abort][nng_aio_abort], +[nng_aio_busy][nng_aio_busy] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/context.md b/docs/reference/src/api/context.md deleted file mode 100644 index 6131b985..00000000 --- a/docs/reference/src/api/context.md +++ /dev/null @@ -1 +0,0 @@ -# Context Functions diff --git a/docs/reference/src/chapter_1.md b/docs/reference/src/chapter_1.md deleted file mode 100644 index b743fda3..00000000 --- a/docs/reference/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/docs/reference/src/refs.md b/docs/reference/src/refs.md index 4c954596..5c67ab09 100644 --- a/docs/reference/src/refs.md +++ b/docs/reference/src/refs.md @@ -81,6 +81,24 @@ [nng_ctx_set]: ../ctx/nng_ctx_set.md [nng_ctx_setopt]: ../ctx/nng_ctx_setopt.md +<!-- Async IO --> + +[nng_aio_abort]: ../aio/nng_aio_abort.md +[nng_aio_alloc]: ../aio/nng_aio_alloc.md +[nng_aio_busy]: ../aio/nng_aio_busy.md +[nng_aio_cancel]: ../aio/nng_aio_cancel.md +[nng_aio_count]: ../aio/nng_aio_count.md +[nng_aio_free]: ../aio/nng_aio_free.md +[nng_aio_get_msg]: ../aio/nng_aio_get_msg.md +[nng_aio_get_output]: ../aio/nng_aio_get_output.md +[nng_aio_result]: ../aio/nng_aio_result.md +[nng_aio_set_input]: ../aio/nng_aio_set_input.md +[nng_aio_set_iov]: ../aio/nng_aio_set_iov.md +[nng_aio_set_msg]: ../aio/nng_aio_set_msg.md +[nng_aio_set_timeout]: ../aio/nng_aio_set_timeout.md +[nng_aio_stop]: ../aio/nng_aio_stop.md +[nng_aio_wait]: ../aio/nng_aio_wait.md + <!-- Threads --> [nng_cv_alloc]: ../thr/nng_cv_alloc.md |
