Idris2Doc : System.Linux.Timerfd

System.Linux.Timerfd

(source)

Reexports

import public Data.C.Ptr
import public System.Linux.Timerfd.Flags
import public System.Linux.Timerfd.Timerfd
import public System.Posix.File
import public System.Posix.Timer

Definitions

timerfd : Has Errno es => EIO1 f => ClockId -> TimerfdFlags -> f es Timerfd
  Opens a new `timerfd` file descriptor for observing the given clock.

Notes:
* A `timerfd` should be closed using `close` just like other file
descriptors.
* In general, use `readTimerfd` instead of the `read` functions
from `System.Posix.File` to read from a `timerfd`.

Totality: total
Visibility: export
setitime : Has Errno es => EIO1 f => Timerfd -> Bits32 -> IOTimerspec -> IOTimerspec -> f es ()
  Sets the time of a `timerfd`.

The currently set time will be stored in `old`.
Use the `TFD_TIMER_ABSTIME` flag if the time should be interpreted as
an absolute wall clock time.

Totality: total
Visibility: export
getitime : HasIO io => Timerfd -> IOTimerspec -> io ()
  Reads the currently set `itimerspec` of a `timerfd` and uses the given
pointer to place the data.

Totality: total
Visibility: export
readTimerfd : Has Errno es => EIO1 f => Timerfd -> f es Bits64
  Reads data from a `timerfd`.

This will block until the next time the timer expires unless `TFD_NONBLOCK`
was set when creating the timer.

The value returned is the number of times the timer expired since
the last read.

Totality: total
Visibility: export
setTime : Has Errno es => EIO1 f => Timerfd -> Bits32 -> Timerspec -> f es ()
  Like `setitime` but without storing the currently set `itimerspec`.

Totality: total
Visibility: export
getTime : Has Errno es => EIO1 f => Timerfd -> f es Timerspec
  Convenience alias for `getitime`.

Totality: total
Visibility: export