System.KQueue

This module contains a low-level binding to the kqueue interface. It stays close to the C API, changing the types to more native Haskell types, but not significantly changing it. See the kqueue man page or the examples in examples/ for usage information. For a higher-level binding, see System.KQueue.HighLevel.

Documentation

data KQueue

A kernel event queue.

kqueue :: IO KQueue

Create a new KQueue.

data KEvent

A kernel event.

Constructors

KEvent

Fields

• ident :: CULong

  The identifier for the event, often a file descriptor.

• evfilter :: Filter

  The kernel filter (type of event).

• flags :: [Flag]

  Actions to perform on the event.

• fflags :: [FFlag]

  Filter-specific flags.

• data_ :: CLong

  Filter-specific data value.

• udata :: Ptr ()

  User-defined data, passed through unchanged.

Instances

Eq KEvent

Methods

(==) :: KEvent -> KEvent -> Bool

(/=) :: KEvent -> KEvent -> Bool

Show KEvent

Methods

showsPrec :: Int -> KEvent -> ShowS

show :: KEvent -> String

showList :: [KEvent] -> ShowS

Storable KEvent

Methods

sizeOf :: KEvent -> Int

alignment :: KEvent -> Int

peekElemOff :: Ptr KEvent -> Int -> IO KEvent

pokeElemOff :: Ptr KEvent -> Int -> KEvent -> IO ()

peekByteOff :: Ptr b -> Int -> IO KEvent

pokeByteOff :: Ptr b -> Int -> KEvent -> IO ()

peek :: Ptr KEvent -> IO KEvent

poke :: Ptr KEvent -> KEvent -> IO ()

data Filter

The types of kernel events.

Constructors

EvfiltTimer

EvfiltSignal

EvfiltProc

EvfiltVnode

EvfiltAio

EvfiltWrite

EvfiltRead

Instances

Enum Filter

Methods

succ :: Filter -> Filter

pred :: Filter -> Filter

toEnum :: Int -> Filter

fromEnum :: Filter -> Int

enumFrom :: Filter -> [Filter]

enumFromThen :: Filter -> Filter -> [Filter]

enumFromTo :: Filter -> Filter -> [Filter]

enumFromThenTo :: Filter -> Filter -> Filter -> [Filter]

Eq Filter

Methods

(==) :: Filter -> Filter -> Bool

(/=) :: Filter -> Filter -> Bool

Show Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

data Flag

The actions to perform on the event.

Constructors

EvAdd

EvDelete

EvEnable

EvDisable

EvOneshot

EvClear

EvReceipt

EvError

EvEof

Instances

Enum Flag

Methods

succ :: Flag -> Flag

pred :: Flag -> Flag

toEnum :: Int -> Flag

fromEnum :: Flag -> Int

enumFrom :: Flag -> [Flag]

enumFromThen :: Flag -> Flag -> [Flag]

enumFromTo :: Flag -> Flag -> [Flag]

enumFromThenTo :: Flag -> Flag -> Flag -> [Flag]

Eq Flag

Methods

(==) :: Flag -> Flag -> Bool

(/=) :: Flag -> Flag -> Bool

Show Flag

Methods

showsPrec :: Int -> Flag -> ShowS

show :: Flag -> String

showList :: [Flag] -> ShowS

data FFlag

The filter specific flags.

Constructors

NoteDelete

NoteWrite

NoteExtend

NoteAttrib

NoteLink

NoteRename

NoteRevoke

NoteSignal

NoteExec

NoteFork

NoteExit

Instances

Enum FFlag

Methods

succ :: FFlag -> FFlag

pred :: FFlag -> FFlag

toEnum :: Int -> FFlag

fromEnum :: FFlag -> Int

enumFrom :: FFlag -> [FFlag]

enumFromThen :: FFlag -> FFlag -> [FFlag]

enumFromTo :: FFlag -> FFlag -> [FFlag]

enumFromThenTo :: FFlag -> FFlag -> FFlag -> [FFlag]

Eq FFlag

Methods

(==) :: FFlag -> FFlag -> Bool

(/=) :: FFlag -> FFlag -> Bool

Show FFlag

Methods

showsPrec :: Int -> FFlag -> ShowS

show :: FFlag -> String

showList :: [FFlag] -> ShowS

kevent

Arguments

:: KQueue

The kernel queue to operate on.

-> [KEvent]

The list of events to start monitoring, or changes to retrieve.

-> Int

The maximum number of events to retrieve.

-> Maybe NominalDiffTime

Timeout. When nothing, blocks until an event has occurred.

-> IO [KEvent]

A list of events that have occurred.

Add events to monitor, or retrieve events from the kqueue. If an error occurs, will throw a KQueueException if there is no room in the returned event list. Otherwise, will set EvError on the event and add it to the returned event list.

data KQueueException

Instances

Show KQueueException

Methods

showsPrec :: Int -> KQueueException -> ShowS

show :: KQueueException -> String

showList :: [KQueueException] -> ShowS

Exception KQueueException

Methods

toException :: KQueueException -> SomeException

fromException :: SomeException -> Maybe KQueueException

displayException :: KQueueException -> String