blob: e44176099b9893bd69a3acd21cb853b55005f1f5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
= 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 conjuction with timers and timeouts.
A couple of special values have been set aside, and carry special meanings.
[[NNG_DURATION_DEFAULT]]((`NNG_DURATION_DEFAULT`)):::
Indicates a context-specific default value should be used.
[[NNG_DURATION_INFINITE]]((`NNG_DURATION_INFINITE`)):::
Effectively an infinite duration; used most often to disable timeouts.
[[NNG_DURATION_ZERO]]((`NNG_DURATION_ZERO`)):::
Zero length duration; used to perform a single polling operation.
== SEE ALSO
[.text-left]
<<nng_options#,nng_options(5)>>,
<<nng#,nng(7)>>
|
