System.Miniplex.Source

Synchronous message receiving.

Documentation

data Source

Instances

Typeable Source

attach :: String -> IO Source

attach tag returns a message source connected to the sink created by a call to System.Miniplex.Sink.create tag. If no such sink exists, an exception is thrown.

attachWait :: String -> IO Source

Similar to attach, but if the specified sink doesn't exist, attachWait blocks until it becomes available.

read :: Source -> IO String

Synchronously reads a message from a source (i.e. it blocks if there is currently no message available).

getMsgs :: Source -> IO [String]

Returns a lazy list of all messages arriving at a source (like System.IO.hGetContents).

detach :: Source -> IO ()

Disconnects from a message sink. The detached source becomes invalid and must not be used again.

withSource :: String -> (Source -> IO a) -> IO a

Helper function to simplify resource handling. withSource tag body creates a source, calls body, then disconnects the source, even if body throws an exception.

withSourceWait :: String -> (Source -> IO a) -> IO a

Similar to withSource, but calls attachWait instead of attach.