From 786abec6eb81a5660f20f7bf2356ad73be1cb2d1 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Fri, 11 Oct 2024 23:38:41 -0700
Subject: Convert nng_duration to mdbook.

---
 docs/ref/api/util/index.md        |  1 +
 docs/ref/api/util/nng_duration.md | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/ref/api/util/nng_duration.md

(limited to 'docs/ref/api')

diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md
index 0650c21d..0a3cb891 100644
--- a/docs/ref/api/util/index.md
+++ b/docs/ref/api/util/index.md
@@ -7,6 +7,7 @@ of other uses.
 
 - [nng_alloc](nng_alloc.md) --- allocate memory
 - [nng_clock](nng_clock.md) --- get time
+- [nng_duration](nng_duration.md) -- relative time in milliseconds
 - [nng_id_map](nng_id_map.md) --- identifier based mapping table
 - [nng_msleep](nng_msleep.md) --- sleep milliseconds
 - [nng_opts_parse](nng_opts_parse.md) --- parse command line options
diff --git a/docs/ref/api/util/nng_duration.md b/docs/ref/api/util/nng_duration.md
new file mode 100644
index 00000000..9ad76256
--- /dev/null
+++ b/docs/ref/api/util/nng_duration.md
@@ -0,0 +1,33 @@
+# nng_duration
+
+## NAME
+
+nng_duration --- relative time in milliseconds
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.h>
+
+typedef int32_t nng_duration;
+
+#define NNG_DURATION_INFINITE (-1)
+#define NNG_DURATION_DEFAULT  (-2)
+#define NNG_DURATION_ZERO     (0)
+```
+
+## DESCRIPTION
+
+An {{i:`nng_duration`}}{{hi:duration}} is a relative time, measured in {{i:milliseconds}}.
+This type is most often used in conjunction with timers and timeouts.
+
+A couple of special values have been set aside, and carry special meanings.
+
+- {{i:`NNG_DURATION_DEFAULT`}}:
+  Indicates a context-specific default value should be used.
+
+- {{i:`NNG_DURATION_INFINITE`}}:
+  Effectively an infinite duration; used most often to disable timeouts.
+
+- {{i:`NNG_DURATION_ZERO`}}:
+  Zero length duration; used to perform an immediate poll.
-- 
cgit v1.2.3-70-g09d2