diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_aio_cancel.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_aio_cancel.adoc')
| -rw-r--r-- | docs/nng_aio_cancel.adoc | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/nng_aio_cancel.adoc b/docs/nng_aio_cancel.adoc deleted file mode 100644 index 22ef0166..00000000 --- a/docs/nng_aio_cancel.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= nng_aio_cancel(3) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// 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 <nng/nng.h> - -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 -<<nng_aio_result#,nng_aio_result(3)>> 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 <<nng_aio_abort#,nng_aio_abort()>> -with the error `NNG_ECANCELED`. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -<<nng_aio_abort#,nng_aio_abort(3)>>, -<<nng_aio_alloc#,nng_aio_alloc(3)>>, -<<nng_aio_result#,nng_aio_result(3)>>, -<<nng#,nng(7)>> |