From 2ac729f333395659c527a21fbcda128b46af7352 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 24 Oct 2024 22:58:47 -0700 Subject: docs: AIO chapter (consumer only) converted to mdbook. --- docs/man/nng_aio_count.3.adoc | 61 ------------------------------------------- 1 file changed, 61 deletions(-) delete mode 100644 docs/man/nng_aio_count.3.adoc (limited to 'docs/man/nng_aio_count.3.adoc') 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. -// 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_count - return number of bytes transferred - -== SYNOPSIS - -[source, c] ----- -#include - -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)] -- cgit v1.2.3-70-g09d2