System.Linux.TimerFD

(source)

Reexports

import public System.Clock

Definitions

data ClockTpe : Type

Totality: total
Visibility: public export
Constructors:

REALTIME : ClockTpe
MONOTONIC : ClockTpe
BOOTTIME : ClockTpe
REALTIME_ALARM : ClockTpe
BOOTTIME_ALARM : ClockTpe

Hints:

Eq ClockTpe
Finite ClockTpe
Show ClockTpe

clockCode : ClockTpe -> Bits32

Totality: total
Visibility: export

record Flags : Type

  Flags describing the behavior of an timer file descriptor.
  
  Several flags can be combined using `(<+>)`.

Totality: total
Visibility: export
Constructor:

F : Bits32 -> Flags

Projection:

.value : Flags -> Bits32

Hints:

Eq Flags
Monoid Flags
Ord Flags
Semigroup Flags
Show Flags

flagCode : Flags -> Bits32

Totality: total
Visibility: export

TFD_CLOEXEC : Flags

Totality: total
Visibility: export

TFD_NONBLOCK : Flags

  Sets the file descriptor to non-blocking: Reading from
  an `TimerFD` via `readTimer` will usually block the calling thread
  unless the file descriptor's timer has already expired at least
  once.
  
  With this flag being set, `readTimer` will never block but will return
  `Left EAGAIN` in case of a still running timer.

Totality: total
Visibility: export

record TimerFD : Type

  A timer file descriptor that can be monitored via `epoll`.

Totality: total
Visibility: public export
Constructor:

TFD : Bits32 -> TimerFD

Projection:

.file : TimerFD -> Bits32

Hint:

FileDesc TimerFD

.file : TimerFD -> Bits32

Totality: total
Visibility: public export

file : TimerFD -> Bits32

Totality: total
Visibility: public export

timerCreate : ClockTpe -> Flags -> PrimIO TimerFD

  Creates a new `TimerFD` with the given initial value a flags set.

Totality: total
Visibility: export

readTimer : TimerFD -> PrimIO (Either EpollErr Bits64)

  Reads the current value from a timer file descriptor, returning the
  number of times the timer has expired since the last read.
  
  This will block the calling thread unless the `TFD_NONBLOCK` flag
  was set.

Totality: total
Visibility: export

setTime : TimerFD -> Clock Duration -> PrimIO ()

Totality: total
Visibility: export

withTimer : ClockTpe -> Flags -> (TimerFD -> PrimIO a) -> PrimIO a

  Creates and finally closes and event file descriptor.

Totality: total
Visibility: export

zero : Clock Duration

  The zero duration.

Totality: total
Visibility: export

.s : Nat -> Clock Duration

  Creates a duration of `n` seconds

Totality: total
Visibility: export

.ns : Nat -> Clock Duration

  Creates a duration of `n` nanoseconds

Totality: total
Visibility: export

.us : Nat -> Clock Duration

  Creates a duration of `n` microseconds

Totality: total
Visibility: export

.ms : Nat -> Clock Duration

  Creates a duration of `n` milliseconds

Totality: total
Visibility: export