diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-20 22:25:53 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-20 22:25:53 -0700 |
| commit | e4e85293cfa0e359b50cd2b57ca0c476632e0c22 (patch) | |
| tree | 9f39dde5a4c4a5623041ce150e4f5fbbe15fde14 /docs/ref/api/util/nng_duration.md | |
| parent | 976d62059097ef715687cbd0abb12ab6f957c882 (diff) | |
| download | nng-e4e85293cfa0e359b50cd2b57ca0c476632e0c22.tar.gz nng-e4e85293cfa0e359b50cd2b57ca0c476632e0c22.tar.bz2 nng-e4e85293cfa0e359b50cd2b57ca0c476632e0c22.zip | |
docs: Move time related functions into single chapter.
Diffstat (limited to 'docs/ref/api/util/nng_duration.md')
| -rw-r--r-- | docs/ref/api/util/nng_duration.md | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/docs/ref/api/util/nng_duration.md b/docs/ref/api/util/nng_duration.md deleted file mode 100644 index 9ad76256..00000000 --- a/docs/ref/api/util/nng_duration.md +++ /dev/null @@ -1,33 +0,0 @@ -# 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. |