Data.Conduit.Network.Firehose

This module is here to let you easily build firehose systems. The firehoseApp application is a standard Application that will stream the events to clients. The firehoseConduit function will spawn a web server on the given port, and let the data-flow in a conduit be examined this way.

For an example implementation, with a JSON encodable data type, see http://hackage.haskell.org/package/hslogstash/docs/src/Data-Conduit-FireHose.html#fireHose.

Documentation

firehoseApp

Arguments

:: Int

Buffer size for the fire hose threads

-> (Request -> a -> Bool)

A filtering function for fire hose messages. Only messages that match this function will be passed. The request can be used to build the filter.

-> (a -> Builder)

The serialization function

-> Firehose a

-> Application

A firehose application, suitable for use in a wai-compatible server. A typical usage is with JSON encodable data, where the serialization function can be :

-- encode to JSON, turn into a Builder, then append a newline.
(<> fromByteString "\n") . fromLazyByteString . encode

The filtering function has a type that let you create it based on the Request. That means you can use the query string to build the proper filters.

firehoseConduit

Arguments

:: (Monad m, MonadIO m)

=> Int

Port to listen on

-> Int

Buffer size for the fire hose threads

-> (Request -> a -> Bool)

A filtering function for fire hose messages. Only messages that match this functions will be passed. The request can be used to build the filter.

-> (a -> Builder)

The serialization function

-> IO (Conduit a m a)

A fire hose conduit creator, that can be inserted in your conduits as firehose entry points. Will run Warp on the specified port. Please not that the connection will timeout after an hour.