From 156753940f75b240a99c058e746c2dc210e8078b Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 6 Oct 2024 17:14:05 -0700 Subject: Remove asciidoc nng_clock and nng_msleep --- docs/man/nng_clock.3supp.adoc | 57 ------------------------------------------ docs/man/nng_msleep.3supp.adoc | 48 ----------------------------------- 2 files changed, 105 deletions(-) delete mode 100644 docs/man/nng_clock.3supp.adoc delete mode 100644 docs/man/nng_msleep.3supp.adoc (limited to 'docs') diff --git a/docs/man/nng_clock.3supp.adoc b/docs/man/nng_clock.3supp.adoc deleted file mode 100644 index 4c91c645..00000000 --- a/docs/man/nng_clock.3supp.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= nng_clock(3supp) -// -// Copyright 2024 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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 - -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 should help with setting appropriate timeouts. - -== 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)] diff --git a/docs/man/nng_msleep.3supp.adoc b/docs/man/nng_msleep.3supp.adoc deleted file mode 100644 index bef74587..00000000 --- a/docs/man/nng_msleep.3supp.adoc +++ /dev/null @@ -1,48 +0,0 @@ -= nng_msleep(3supp) -// -// Copyright 2024 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_msleep - sleep milliseconds - -== SYNOPSIS - -[source, c] ----- -#include - -void nng_msleep(nng_duration msec); ----- - -== DESCRIPTION - -The `nng_msleep()` blocks the caller for at least _msec_ milliseconds. - -NOTE: This function may block for longer than requested. -The actual wait time is determined by the capabilities of the -underlying system. - -== RETURN VALUES - -None. - -== 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_clock.3supp.adoc[nng_clock(3supp)], -xref:nng_duration.5.adoc[nng_duration(5)], -xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2