diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-04-05 00:29:55 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-04-05 00:29:55 -0700 |
| commit | cec3d5e49ad3fb227265b90e915299beab36b45a (patch) | |
| tree | 5ce523ec850c974e942c650945858761f61163c4 /docs/man/nng_clock.3supp.adoc | |
| parent | 5fc6ec2d44e3372445ef4bf3bfb3fadc9d01dc94 (diff) | |
| download | nng-cec3d5e49ad3fb227265b90e915299beab36b45a.tar.gz nng-cec3d5e49ad3fb227265b90e915299beab36b45a.tar.bz2 nng-cec3d5e49ad3fb227265b90e915299beab36b45a.zip | |
Converted some utility pages
Diffstat (limited to 'docs/man/nng_clock.3supp.adoc')
| -rw-r--r-- | docs/man/nng_clock.3supp.adoc | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/man/nng_clock.3supp.adoc b/docs/man/nng_clock.3supp.adoc deleted file mode 100644 index d413f1b2..00000000 --- a/docs/man/nng_clock.3supp.adoc +++ /dev/null @@ -1,59 +0,0 @@ -= nng_clock(3supp) -// -// 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_clock - get time - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/supplemental/util/platform.h> - -typedef uint64_t nng_time; - -nng_time nng_clock(void); ----- - -== DESCRIPTION - -The `nng_clock()` returns the number of elapsed milliseconds since some -arbitrary time in the past. -The resolution of the clock depends on the underlying timing facilities -of the system. -This function may be used for timing, but applications should not expect -very fine-grained values. - -IMPORTANT: The reference time will be the same for a given program, -but different programs may have different references. - -TIP: This function is intended mostly to help with setting appropriate -timeouts using xref:nng_cv_until.3supp.adoc[`nng_cv_until()`]. - -== RETURN VALUES - -Milliseconds since reference time. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_sleep_aio.3.adoc[nng_sleep_aio(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_cv_until.3supp.adoc[nng_cv_until(3supp)], -xref:nng_msleep.3supp.adoc[nng_msleep(3supp)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng.7.adoc[nng(7)] |
