summaryrefslogtreecommitdiff
path: root/docs/nng_aio_finish.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
commit87795b46f2bc732bd11067805709161bdc00d6b6 (patch)
tree892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_aio_finish.adoc
parent545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff)
downloadnng-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_finish.adoc')
-rw-r--r--docs/nng_aio_finish.adoc54
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/nng_aio_finish.adoc b/docs/nng_aio_finish.adoc
deleted file mode 100644
index 42c51970..00000000
--- a/docs/nng_aio_finish.adoc
+++ /dev/null
@@ -1,54 +0,0 @@
-= nng_aio_finish(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_finish - finish asynchronous I/O operation
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-
-void nng_aio_finish(nng_aio *aio, int err);
------------
-
-== DESCRIPTION
-
-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#,nng_aio_result(3)>>.
-
-This function causes the callback associated with the _aio_ to called.
-
-WARNING: It is mandatory that operation "providers" call this function
-*EXACTLY ONCE* when they are finished with the operation. After calling this
-function they *MUST NOT* perform any further accesses the _aio_.
-
-WARNING: This function is only for I/O providers (those actually performing
-the operation such as HTTP handler function or a transport provider); ordinary
-users of the _aio_ should not have any need for this function.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-<<nng_aio_alloc#,nng_aio_alloc(3)>>,
-<<nng_aio_cancel#,nng_aio_cancel(3)>>,
-<<nng_aio_result#,nng_aio_result(3)>>,
-<<nng#,nng(7)>>