Idris2Doc : System.Linux.Epoll

System.Linux.Epoll

(source)

Reexports

import public System.Linux.Error
import public System.Linux.File

Definitions

epollin : Bits32
epollout : Bits32
epollrdhup : Bits32
epollpri : Bits32
epollerr : Bits32
epollhup : Bits32
record Events : Type
  Type of events epoll can wait for.

For every file descriptor observed by epoll a
combination of events can be watched for. Events
can be combined via `(<+>)`.

Totality: total
Visibility: export
Constructor: 
E : Bits32 -> Events

Projection: 
.value : Events -> Bits32

Hints:
Eq Events
Ord Events
Semigroup Events
Show Events
eventCode : Events -> Bits32
Totality: total
Visibility: export
EPOLLIN : Events
  Event for observing if a file is ready for input, that is,
`read` invoked with that file will not block.

Totality: total
Visibility: export
EPOLLOUT : Events
  Event for observing if a file is ready for output, that is,
`write` invoked with that file will not block.

Totality: total
Visibility: export
EPOLLRDHUP : Events
Totality: total
Visibility: export
EPOLLPRI : Events
Totality: total
Visibility: export
EPOLLERR : Events
Totality: total
Visibility: export
EPOLLHUP : Events
Totality: total
Visibility: export
epollet : Bits32
epolloneshot : Bits32
epollwakeup : Bits32
epollexclusive : Bits32
record Flags : Type
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
EPOLLET : Flags
Totality: total
Visibility: export
EPOLLONESHOT : Flags
Totality: total
Visibility: export
EPOLLWAKEUP : Flags
Totality: total
Visibility: export
EPOLLEXCLUSIVE : Flags
Totality: total
Visibility: export
record EpollEvent : Type
Totality: total
Visibility: export
Constructor: 
EE : AnyPtr -> EpollEvent

Projection: 
.ptr : EpollEvent -> AnyPtr
record EpollEvents : Nat -> Type
Totality: total
Visibility: export
Constructor: 
EES : AnyPtr -> EpollEvents n

Projection: 
.ptr : EpollEvents n -> AnyPtr
record EpollFD : Type
Totality: total
Visibility: export
Constructor: 
EFD : Bits32 -> AnyPtr -> EpollFD

Projections:
.event : EpollFD -> AnyPtr
.file : EpollFD -> Bits32

Hint: 
Show EpollFD
epollAdd : FileDesc a => EpollFD -> a -> Events -> Flags -> PrimIO (Either EpollErr ())
  Adds, modifies, or removes interest in the given file descriptor
at an epoll instance.

Totality: total
Visibility: export
epollMod : FileDesc a => EpollFD -> a -> Events -> Flags -> PrimIO (Either EpollErr ())
  Adds, modifies, or removes interest in the given file descriptor
at an epoll instance.

Totality: total
Visibility: export
epollDel : FileDesc a => EpollFD -> a -> PrimIO (Either EpollErr ())
  Adds, modifies, or removes interest in the given file descriptor
at an epoll instance.

Totality: total
Visibility: export
epollCreate : IO (Either EpollErr EpollFD)
  Creates a new epoll file descriptor that can be used to monitor
other file descriptors for readiness.

Totality: total
Visibility: export
data EpollRes : Type
Totality: total
Visibility: public export
Constructors:
NoEv : EpollRes
Ev : Bits32 -> Events -> EpollRes
Err : EpollErr -> EpollRes

Hints:
Eq EpollRes
Show EpollRes
epollClose : EpollFD -> PrimIO ()
Totality: total
Visibility: export
epollWait : EpollFD -> Int32 -> PrimIO EpollRes
Totality: total
Visibility: export
epollWaitTimeout : EpollFD -> Bits32 -> PrimIO EpollRes
Totality: total
Visibility: export
epollNoWait : EpollFD -> PrimIO EpollRes
Totality: total
Visibility: export