diff options
Diffstat (limited to 'docs/man/nng_aio_count.adoc')
| -rw-r--r-- | docs/man/nng_aio_count.adoc | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/docs/man/nng_aio_count.adoc b/docs/man/nng_aio_count.adoc deleted file mode 100644 index 6ea42bf9..00000000 --- a/docs/man/nng_aio_count.adoc +++ /dev/null @@ -1,58 +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 <<nng_aio_set_iov#,nng_aio_set_iov(3)>>). - -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 -<<nng_aio_wait#,nng_aio_wait(3)>>. - -== RETURN VALUES - -The number of bytes transferred by the operation. - -== ERRORS - -None. - -== SEE ALSO - -<<nng_aio_alloc#,nng_aio_alloc(3)>>, -<<nng_aio_result#,nng_aio_result(3)>>, -<<nng_aio_set_iov#,nng_aio_set_iov(3)>>, -<<nng_aio_wait#,nng_aio_wait(3)>>, -<<nng_strerror#,nng_strerror(3)>>, -<<nng#,nng(7)>> |
