From 68f3fd06531455aec4b2332bed1592795e69c3fa Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Mon, 5 Feb 2018 11:17:15 -0800
Subject: Document nng_aio_xxx asynchronous I/O API.

---
 docs/nng_aio_set_timeout.adoc | 64 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 docs/nng_aio_set_timeout.adoc

(limited to 'docs/nng_aio_set_timeout.adoc')

diff --git a/docs/nng_aio_set_timeout.adoc b/docs/nng_aio_set_timeout.adoc
new file mode 100644
index 00000000..3ca4ad19
--- /dev/null
+++ b/docs/nng_aio_set_timeout.adoc
@@ -0,0 +1,64 @@
+= nng_aio_set_timeout(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
+            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
+            {blank} + \
+            This document is supplied under the terms of the \
+            https://opensource.org/licenses/MIT[MIT License].
+
+== 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);
+-----------
+
+== DESCRIPTION
+
+The `nng_aio_set_timeout()` function sets a _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`.)
+
+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
+
+<<nng_aio_alloc#,nng_aio_alloc(3)>>,
+<<nng_aio_cancel#,nng_aio_cancel(3)>>,
+<<nng_aio_result#,nng_aio_result(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}
-- 
cgit v1.2.3-70-g09d2

