From abb4dcaf84b4224788c1d343fe557079e053ee5b Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 24 Mar 2024 13:36:51 -0700 Subject: subdir for compmat --- docs/man/nng_aio_result.3.adoc | 59 ------------------------------------------ 1 file changed, 59 deletions(-) delete mode 100644 docs/man/nng_aio_result.3.adoc (limited to 'docs/man/nng_aio_result.3.adoc') diff --git a/docs/man/nng_aio_result.3.adoc b/docs/man/nng_aio_result.3.adoc deleted file mode 100644 index e1886a6e..00000000 --- a/docs/man/nng_aio_result.3.adoc +++ /dev/null @@ -1,59 +0,0 @@ -= nng_aio_result(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_result - return result of asynchronous operation - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_aio_result(nng_aio *aio); ----- - -== DESCRIPTION - -The `nng_aio_result()` returns the result of the operation associated -with the handle _aio_. -If the operation was successful, then 0 is returned. -Otherwise a non-zero error code is returned. - -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 result of the operation, either zero on success, or an error -number on failure. - -== ERRORS - -[horizontal] -`NNG_ETIMEDOUT`:: The operation timed out. -`NNG_ECANCELED`:: The operation was canceled. - -Various other return values are possible depending on the operation. - -== SEE ALSO - -[.text-left] -xref:nng_aio_abort.3.adoc[nng_aio_abort(3)], -xref:nng_aio_alloc.3.adoc[nng_aio_alloc(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