diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-11 23:38:41 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-11 23:38:41 -0700 |
| commit | 786abec6eb81a5660f20f7bf2356ad73be1cb2d1 (patch) | |
| tree | ca3b2625326e82b6d3d603114df44da62c668bc6 /docs/man | |
| parent | 6b0b26ba0cc45ce481d76be3c22c0a4f0addf4ae (diff) | |
| download | nng-786abec6eb81a5660f20f7bf2356ad73be1cb2d1.tar.gz nng-786abec6eb81a5660f20f7bf2356ad73be1cb2d1.tar.bz2 nng-786abec6eb81a5660f20f7bf2356ad73be1cb2d1.zip | |
Convert nng_duration to mdbook.
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/nng_duration.5.adoc | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/man/nng_duration.5.adoc b/docs/man/nng_duration.5.adoc deleted file mode 100644 index fbd172b9..00000000 --- a/docs/man/nng_duration.5.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= nng_duration(5) -// -// Copyright 2018 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_duration - relative time in milliseconds - -== SYNOPSIS - -[source, 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 `nng_duration`(((duration))) is a relative time, measured in -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. - -((`NNG_DURATION_DEFAULT`))::: -Indicates a context-specific default value should be used. - -((`NNG_DURATION_INFINITE`))::: -Effectively an infinite duration; used most often to disable timeouts. - -((`NNG_DURATION_ZERO`))::: -Zero length duration; used to perform a single polling operation. - -== SEE ALSO - -[.text-left] -xref:nng_options.5.adoc[nng_options(5)], -xref:nng.7.adoc[nng(7)] |