diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/api/aio/aio_cancel.md | 54 | ||||
| -rw-r--r-- | docs/ref/api/util/index.md | 19 |
2 files changed, 0 insertions, 73 deletions
diff --git a/docs/ref/api/aio/aio_cancel.md b/docs/ref/api/aio/aio_cancel.md deleted file mode 100644 index 118c9b5a..00000000 --- a/docs/ref/api/aio/aio_cancel.md +++ /dev/null @@ -1,54 +0,0 @@ -# aio_cancel - -## NAME - -aio_cancel --- canceling asynchronous I/O - -## SYNOPSIS - -```c -#include <nng/nng.h> - -void nng_aio_abort(nng_aio *aio, int err); -void nng_aio_cancel(nng_aio *aio); -void nng_aio_stop(nng_aio *aio); -``` - -## DESCRIPTION - -These functions are used to stop a previously submitted asynchronous -I/O operation. The operation may be canceled, or may continue to -completion. If no operation is in progress (perhaps because it has -already completed), then these operations have no effect. -If the operation is successfully canceled or aborted, then the callback -will still be called. - -The {{i:`nng_aio_abort`}} function aborts the operation associated with _aio_ -and returns immediately without waiting. If cancellation was successful, -then [`nng_aio_result`][nng_aio_result] will return _err_. - -The {{i:`nng_aio_cancel`}} function acts like `nng_aio_abort`, but uses the error code -{{i:`NNG_ECANCELED`}}. - -The {{i:`nng_aio_stop`}} function aborts the _aio_ operation with `NNG_ECANCELED`, -and then waits the operation and any associated callback to complete. -This function also marks _aio_ itself permanently stopped, so that any -new operations scheduled by I/O providers using [`nng_aio_begin`][nng_aio_begin] -return false. Thus this function should be used to teardown operations. - -> [!TIP] -> When multiple asynchronous I/O handles are in use and need to be -> deallocated, it is safest to stop all of them using `nng_aio_stop`, -> before deallocating any of them with [`nng_aio_free`][nng_aio_free], -> particularly if the callbacks might attempt to reschedule further operations. - -## SEE ALSO - -[nng_aio][nng_aio], -[nng_aio_result][nng_aio_result], -[nng_aio_free][nng_aio_free] - -[nng_aio]: TODO.md -[nng_aio_begin]: TODO.md -[nng_aio_result]: TODO.md -[nng_aio_free]: TODO.md diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md deleted file mode 100644 index a4dcbf12..00000000 --- a/docs/ref/api/util/index.md +++ /dev/null @@ -1,19 +0,0 @@ -# Utility Functions - -This section documents various utility functions that may help -with application portability. These are not fundamental to NNG -or Scalability Protocols, but they are likely useful for a variety -of other uses. - -- [nng_alloc](nng_alloc.md) --- allocate memory -- [nng_clock](nng_clock.md) --- get time -- [nng_duration](nng_duration.md) -- relative time in milliseconds -- [nng_id_map](nng_id_map.md) --- identifier based mapping table -- [nng_msleep](nng_msleep.md) --- sleep milliseconds -- [nng_opts_parse](nng_opts_parse.md) --- parse command line options -- [nng_random](nng_random.md) --- get random number -- [nng_socket_pair](nng_socket_pair.md) --- create a connected pair of BSD sockets -- [nng_strdup](nng_strdup.md) --- duplicate string -- [nng_strerror](nng_strerror.md) --- return an error description -- [nng_url](nng_url.md) --- Universal Resource Locator object -- [nng_version](nng_version.md) --- report library version |