aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_count.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-24 22:58:47 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-24 22:58:47 -0700
commit2ac729f333395659c527a21fbcda128b46af7352 (patch)
treeac74c91d043cac21e66e856f73dd4bbd52b2eb64 /docs/man/nng_aio_count.3.adoc
parent3b1615c0dea75b082b7d27b73fbce65a836a87e2 (diff)
downloadnng-2ac729f333395659c527a21fbcda128b46af7352.tar.gz
nng-2ac729f333395659c527a21fbcda128b46af7352.tar.bz2
nng-2ac729f333395659c527a21fbcda128b46af7352.zip
docs: AIO chapter (consumer only) converted to mdbook.
Diffstat (limited to 'docs/man/nng_aio_count.3.adoc')
-rw-r--r--docs/man/nng_aio_count.3.adoc61
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/man/nng_aio_count.3.adoc b/docs/man/nng_aio_count.3.adoc
deleted file mode 100644
index daf97710..00000000
--- a/docs/man/nng_aio_count.3.adoc
+++ /dev/null
@@ -1,61 +0,0 @@
-= nng_aio_count(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_count - return number of bytes transferred
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-size_t nng_aio_count(nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_aio_count()` returns the number of bytes transferred by the
-asynchronous operation associated with the handle _aio_.
-
-Some asynchronous operations do not provide meaningful data for this
-function; for example operations that establish connections do not
-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 xref:nng_aio_set_iov.3.adoc[`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
-xref:nng_aio_wait.3.adoc[`nng_aio_wait()`].
-
-== RETURN VALUES
-
-The number of bytes transferred by the operation.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)],
-xref:nng_aio_wait.3.adoc[nng_aio_wait(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]