aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_set_timeout.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_set_timeout.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_set_timeout.3.adoc')
-rw-r--r--docs/man/nng_aio_set_timeout.3.adoc74
1 files changed, 0 insertions, 74 deletions
diff --git a/docs/man/nng_aio_set_timeout.3.adoc b/docs/man/nng_aio_set_timeout.3.adoc
deleted file mode 100644
index a82b0c83..00000000
--- a/docs/man/nng_aio_set_timeout.3.adoc
+++ /dev/null
@@ -1,74 +0,0 @@
-= nng_aio_set_timeout(3)
-//
-// Copyright 2023 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_set_timeout - set asynchronous I/O timeout
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-typedef int nng_duration;
-void nng_aio_set_timeout(nng_aio *aio, nng_duration timeout);
-
-typedef uint64_t nng_time;
-void nng_aio_set_expire(nng_aio *aio, nng_time expiration);
-----
-
-== DESCRIPTION
-
-The `nng_aio_set_timeout()` function sets a _timeout_(((timeout)))
-for the asynchronous operation associated with _aio_.
-This causes a timer to be started when the operation is actually started.
-If the timer expires before the operation is completed, then it is
-aborted with an error of `NNG_ETIMEDOUT`.
-The _timeout_ is specified as a relative number of milliseconds.
-
-If the timeout is `NNG_DURATION_INFINITE`, then no timeout is used.
-If the timeout is `NNG_DURATION_DEFAULT`, then a "default" or socket-specific
-timeout is used.
-(This is frequently the same as `NNG_DURATION_INFINITE`.)
-
-The `nng_aio_set_expire()` function is similar to `nng_aio_set_timeout()`, but sets
-an absolute expiration time based on the system clock. The _expiration_
-is expressed as a number of milliseconds since some point in the past.
-The xref:nng_clock.3supp.adoc[`nng_clock()`] function can be used to determine
-the current value of the clock.
-
-TIP: As most operations involve some context switching, it is usually a good
-idea to allow at least a few tens of milliseconds before timing them out --
-a too small timeout might not allow the operation to properly begin before
-giving up!
-
-The value of _timeout_ set for the _aio_ is persistent, so that if the
-handle is reused for multiple operations, they will have the same relative
-timeout.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
-xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng_duration.5.adoc[nng_duration(5)],
-xref:nng.7.adoc[nng(7)]