From caa25a822565687833ffe6caf211a55c0cb95a65 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 18 Oct 2024 22:32:48 -0700 Subject: aio cancellation docs converted to mdbook --- docs/man/nng_aio_abort.3.adoc | 55 -------------------------------------- docs/man/nng_aio_cancel.3.adoc | 58 ---------------------------------------- docs/man/nng_aio_stop.3.adoc | 60 ------------------------------------------ docs/ref/api/aio/aio_cancel.md | 55 ++++++++++++++++++++++++++++++++++++++ docs/ref/api/aio/index.md | 1 + 5 files changed, 56 insertions(+), 173 deletions(-) delete mode 100644 docs/man/nng_aio_abort.3.adoc delete mode 100644 docs/man/nng_aio_cancel.3.adoc delete mode 100644 docs/man/nng_aio_stop.3.adoc create mode 100644 docs/ref/api/aio/aio_cancel.md create mode 100644 docs/ref/api/aio/index.md (limited to 'docs') diff --git a/docs/man/nng_aio_abort.3.adoc b/docs/man/nng_aio_abort.3.adoc deleted file mode 100644 index 8d4e904b..00000000 --- a/docs/man/nng_aio_abort.3.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= nng_aio_abort(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_aio_abort - abort asynchronous I/O operation - -== SYNOPSIS - -[source, c] ----- -#include - -void nng_aio_abort(nng_aio *aio, int err); ----- - -== DESCRIPTION - -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 -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. - -If no operation is currently in progress (either because it has already -finished, or no operation has been started yet), then this function -has no effect. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -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_cancel.3.adoc b/docs/man/nng_aio_cancel.3.adoc deleted file mode 100644 index 3b32c827..00000000 --- a/docs/man/nng_aio_cancel.3.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= nng_aio_cancel(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_aio_cancel - cancel asynchronous I/O operation - -== SYNOPSIS - -[source, c] ----- -#include - -void nng_aio_cancel(nng_aio *aio); ----- - -== DESCRIPTION - -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 -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. - -If no operation is currently in progress (either because it has already -finished, or no operation has been started yet), then this function -has no effect. - -NOTE: This function is the same as calling -xref:nng_aio_abort.3.adoc[`nng_aio_abort()`] with the error `NNG_ECANCELED`. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], -xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], -xref:nng_aio_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_stop.3.adoc b/docs/man/nng_aio_stop.3.adoc deleted file mode 100644 index d5037c51..00000000 --- a/docs/man/nng_aio_stop.3.adoc +++ /dev/null @@ -1,60 +0,0 @@ -= nng_aio_stop(3) -// -// Copyright 2024 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_aio_stop - stop asynchronous I/O operation - -== SYNOPSIS - -[source, c] ----- -#include - -void nng_aio_stop(nng_aio *aio); ----- - -== DESCRIPTION - -The `nng_aio_stop()` function stops the asynchronous I/O operation -associated with _aio_ by aborting with `NNG_ECANCELED`, and then waits -for it to complete or to be completely aborted, and for the -callback associated with the _aio_ to have completed executing. - -Further calls to -xref:nng_aio_begin.3.adoc[`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. - -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 xref:nng_aio_free.3.adoc[`nng_aio_free()`], particularly if the callbacks -might attempt to reschedule additional operations. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], -xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)], -xref:nng_aio_free.3.adoc[nng_aio_free(3)], -xref:nng_aio_begin.3.adoc[nng_aio_begin(3)], -xref:nng_aio_wait.3.adoc[nng_aio_wait(3)], -xref:nng_aio.5.adoc[nng_aio(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/ref/api/aio/aio_cancel.md b/docs/ref/api/aio/aio_cancel.md new file mode 100644 index 00000000..8d4e904b --- /dev/null +++ b/docs/ref/api/aio/aio_cancel.md @@ -0,0 +1,55 @@ += nng_aio_abort(3) +// +// Copyright 2018 Staysail Systems, Inc. +// Copyright 2018 Capitar IT Group BV +// +// This document is supplied under the terms of the MIT License, a +// copy of which should be located in the distribution where this +// file was obtained (LICENSE.txt). A copy of the license may also be +// found online at https://opensource.org/licenses/MIT. +// + +== NAME + +nng_aio_abort - abort asynchronous I/O operation + +== SYNOPSIS + +[source, c] +---- +#include + +void nng_aio_abort(nng_aio *aio, int err); +---- + +== DESCRIPTION + +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 +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. + +If no operation is currently in progress (either because it has already +finished, or no operation has been started yet), then this function +has no effect. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +[.text-left] +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/ref/api/aio/index.md b/docs/ref/api/aio/index.md new file mode 100644 index 00000000..1e9872e9 --- /dev/null +++ b/docs/ref/api/aio/index.md @@ -0,0 +1 @@ +# Asynchronous I/O Operations -- cgit v1.2.3-70-g09d2