[notcurses_input.3] update to specify CLOCK_MONOTONIC

This commit is contained in:
nick black 2021-10-26 09:59:33 -04:00
parent b9c4d359af
commit 95f659d62b
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC

View File

@ -71,10 +71,10 @@ to fill whenever it reads.
**notcurses_get** allows a **struct timespec** to be specified as a timeout. **notcurses_get** allows a **struct timespec** to be specified as a timeout.
If **ts** is **NULL**, **notcurses_get** will block until it reads input, or If **ts** is **NULL**, **notcurses_get** will block until it reads input, or
is interrupted by a signal. If its values are zeroes, there will be no blocking. is interrupted by a signal. If its values are zeroes, there will be no
Otherwise, **ts** specifies an absolute deadline (using the same source and blocking. Otherwise, **ts** specifies an absolute deadline (taken against
timezone as **gettimeofday(2)**). On timeout, 0 is returned. Event **CLOCK_MONOTONIC**; see **clock_gettime(2)**). On timeout, 0 is returned.
details will be reported in **ni**, unless **ni** is NULL. Event details will be reported in **ni**, unless **ni** is NULL.
**notcurses_inputready_fd** provides a file descriptor suitable for use with **notcurses_inputready_fd** provides a file descriptor suitable for use with
I/O multiplexors such as **poll(2)**. This file descriptor might or might not I/O multiplexors such as **poll(2)**. This file descriptor might or might not
@ -195,9 +195,12 @@ Mouse events in the top and left margins will never be delivered to the
application (as is intended), but mouse events in the bottom and right margins application (as is intended), but mouse events in the bottom and right margins
sometimes can be if the event occurs prior to a window resize. sometimes can be if the event occurs prior to a window resize.
On some operating systems, **CLOCK_REALTIME** is used as the basis for
timeouts instead of **CLOCK_MONOTONIC**. This ought be fixed.
# SEE ALSO # SEE ALSO
**gettimeofday(2)**, **clock_gettime(2)**,
**poll(2)**, **poll(2)**,
**notcurses(3)**, **notcurses(3)**,
**notcurses_refresh(3)**, **notcurses_refresh(3)**,