System.Linux.EpollM

Monadic epoll interface. Similar to System.Linux.Epoll.Base but uses ReaderT to hold a Device instead of passing it to many functions.

Documentation

data Epoll a

Instances

Monad Epoll

MonadIO Epoll

MonadReader Device Epoll

runEpoll :: Device -> Epoll a -> IO a

Run Epoll monad.

runEpoll_ :: Size -> Epoll a -> IO a

Run Epoll monad. Like runEpoll but creates and closes Device implcitely.

runEpollSmall_ :: Epoll a -> IO a

Like runEpoll_ but with an implicit Size value of 8.

runEpollMed_ :: Epoll a -> IO a

Like runEpoll_ but with an implicit Size value of 256.

runEpollBig_ :: Epoll a -> IO a

Like runEpoll_ but with an implicit Size value of 8192.

add :: a -> [EventType] -> Fd -> Epoll (Descriptor a)

Adds the given file descriptor with the specified event types to epoll.

add_ :: [EventType] -> Fd -> Epoll (Descriptor ())

Like add but without accepting custom data.

modify :: [EventType] -> Descriptor a -> Epoll ()

Modify the event type set of the given descriptor.

delete :: Descriptor a -> Epoll ()

Deletes the descriptor from epoll.

wait :: Duration -> Epoll [Event a]

Waits up to the given duration for events on all descriptors.

wait_ :: Epoll [Event a]

Like wait but uses a Duration of 500ms.

device :: Epoll Device

dispatchLoop :: Duration -> (Event a -> Epoll ()) -> Epoll ()

Waits for events and calls the given function for each.

dispatchLoop_ :: Duration -> (Event a -> Epoll ()) -> Epoll ThreadId

Like dispatchLoop but forks itself into another thread

defaultDispatchLoop :: (Event a -> Epoll ()) -> Epoll ()

Like dispatchLoop but with predefined Duration of 500ms.

defaultDispatchLoop_ :: (Event a -> Epoll ()) -> Epoll ThreadId

Like defaultDispatchLoop but forks itself into another thread

fork :: Epoll () -> Epoll ThreadId

Uses forkIO to spark an epoll computation into another thread.

fork_ :: Epoll () -> Epoll ()

Like fork but swallows the ThreadId.

data EventType

EventType corresponds to epoll's event type defines, e.g. EPOLLIN, EPOLLOUT, EPOLLET, etc.

Instances

Eq EventType

Ord EventType

Show EventType

data Size

Unsigned type used for length specifications.

Instances

Eq Size

Ord Size

Show Size

toSize :: Int -> Maybe Size

data Duration

Unsigned type used for timeout specifications.

Instances

Eq Duration

Ord Duration

Show Duration

toDuration :: Int -> Maybe Duration

data Descriptor a

Event descriptor. Will be returned from add and must be passed to delete exactly once.

data Device

Abstract epoll device. Holds internal data. Returned from create and used in almost every other API function. Must be closed explicitely with close.

Instances

Eq Device

Show Device

MonadReader Device Epoll

data Event a

A single event ocurrence.

(=~) :: EventType -> EventType -> Bool

Match operator. Useful to test whether an EventType returned from wait contains one of the defined event types because EventTypes returned by wait might be the bitwise OR of several EventTypes.

create :: Size -> IO Device

Creates an epoll device. Must be closed with close. The parameter Size specifies the number of events that can be reported by a single call to wait.

close :: Device -> IO ()

Closes epoll device.

inEvent :: EventType

outEvent :: EventType

peerCloseEvent :: EventType

urgentEvent :: EventType

errorEvent :: EventType

hangupEvent :: EventType

edgeTriggeredEvent :: EventType

oneShotEvent :: EventType