Idris2Doc : System.Linux.SignalFD

System.Linux.SignalFD

(source)

Reexports

import public System.Signal

Definitions

record Flags : Type
  Flags describing the behavior of an signal 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
SFD_CLOEXEC : Flags
Totality: total
Visibility: export
SFD_NONBLOCK : Flags
  Sets the file descriptor to non-blocking: Reading from
a `SignalFD` via `readSignal` will usually block the calling thread
unless the file descriptor's signal has been caught.

With this flag being set, `readSignal` will never block but will return
`Left EAGAIN` in case of a still running signal.

Totality: total
Visibility: export
record SignalFD : Type
  A signal file descriptor that can be monitored via `epoll`.

Totality: total
Visibility: public export
Constructor: 
SFD : Bits32 -> SignalFD

Projection: 
.file : SignalFD -> Bits32

Hint: 
FileDesc SignalFD
.file : SignalFD -> Bits32
Totality: total
Visibility: public export
file : SignalFD -> Bits32
Totality: total
Visibility: public export
signalCreate : List Signal -> Flags -> PrimIO SignalFD
  Creates a new `SignalFD`, observing the given signals
with the given flags set.

Note: Make sure to block the given list of signals to prevent their
default behavior. The easiest way to do so is by using
`blockSignals` at the beginning of your application.

Totality: total
Visibility: export
blockSignals : List Signal -> PrimIO ()
  Block default handling for the given list of signals.

Totality: total
Visibility: export
readSignal : SignalFD -> PrimIO (Either EpollErr Bits32)
  Reads the next caught signal from a signal file descriptor.

Totality: total
Visibility: export
withSignal : List Signal -> Flags -> (SignalFD -> PrimIO a) -> PrimIO a
  Creates and finally closes and event file descriptor.

Totality: total
Visibility: export
raise : Signal -> PrimIO ()
Totality: total
Visibility: export