Safe Haskell	None
Language	Haskell2010

Network.HTTP.Semantics.IO

Synopsis

type ReadN = Int -> IO ByteString
defaultReadN :: Socket -> IORef (Maybe ByteString) -> ReadN
type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount
type PositionReadMaker = FilePath -> IO (PositionRead, Sentinel)
data Sentinel
- = Closer (IO ())
- | Refresher (IO ())
defaultPositionReadMaker :: PositionReadMaker
data Next = Next BytesFilled Bool (Maybe DynaNext)
type DynaNext = Buffer -> Int -> IO Next
type BytesFilled = Int
data StreamingChunk
type CleanupStream = IO ()
fillBuilderBodyGetNext :: Builder -> DynaNext
fillFileBodyGetNext :: PositionRead -> FileOffset -> ByteCount -> IO () -> DynaNext
fillStreamBodyGetNext :: IO (Maybe StreamingChunk) -> DynaNext
type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker
data NextTrailersMaker
- = NextTrailersMaker TrailersMaker
- | Trailers [Header]
defaultTrailersMaker :: TrailersMaker
runTrailersMaker :: TrailersMaker -> Buffer -> Int -> IO NextTrailersMaker

Documentation

type ReadN = Int -> IO ByteString Source #

Reading n bytes.

defaultReadN :: Socket -> IORef (Maybe ByteString) -> ReadN Source #

Naive implementation for readN.

type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount Source #

Position read for files.

type PositionReadMaker = FilePath -> IO (PositionRead, Sentinel) Source #

Making a position read and its closer.

data Sentinel Source #

Constructors

Closer (IO ())	Closing a file resource. Its refresher is automatiaclly generated by the internal timer.
Refresher (IO ())	Refreshing a file resource while reading. Closing the file must be done by its own timer or something.

defaultPositionReadMaker :: PositionReadMaker Source #

Position read based on Handle.

data Next Source #

Constructors

Next BytesFilled Bool (Maybe DynaNext)

type DynaNext = Buffer -> Int -> IO Next Source #

type BytesFilled = Int Source #

data StreamingChunk Source #

Constructors

StreamingFinished CleanupStream

Indicate that the stream is finished

StreamingFlush

Flush the stream

This will cause the write buffer to be written to the network socket, without waiting for more data.

StreamingBuilder Builder (Maybe CleanupStream)

Construct a DATA frame, optionally terminating the stream

The optional CleanupStream argument can be used to ensure that the final DATA frame in the stream is marked as end-of-stream, as opposed to using a separate, empty, data frame with this flag set.

type CleanupStream = IO () Source #

Action to run prior to terminating the stream

fillBuilderBodyGetNext :: Builder -> DynaNext Source #

fillFileBodyGetNext :: PositionRead -> FileOffset -> ByteCount -> IO () -> DynaNext Source #

fillStreamBodyGetNext :: IO (Maybe StreamingChunk) -> DynaNext Source #

type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker Source #

Trailers maker. A chunks of the response body is passed with Just. The maker should update internal state with the ByteString and return the next trailers maker. When response body reaches its end, Nothing is passed and the maker should generate trailers. An example:

{-# LANGUAGE BangPatterns #-}
import Data.ByteString (ByteString)
import qualified Data.ByteString.Char8 as C8
import Crypto.Hash (Context, SHA1) -- cryptonite
import qualified Crypto.Hash as CH

-- Strictness is important for Context.
trailersMaker :: Context SHA1 -> Maybe ByteString -> IO NextTrailersMaker
trailersMaker ctx Nothing = return $ Trailers [("X-SHA1", sha1)]
  where
    !sha1 = C8.pack $ show $ CH.hashFinalize ctx
trailersMaker ctx (Just bs) = return $ NextTrailersMaker $ trailersMaker ctx'
  where
    !ctx' = CH.hashUpdate ctx bs

Usage example:

let h2rsp = responseFile ...
    maker = trailersMaker (CH.hashInit :: Context SHA1)
    h2rsp' = setResponseTrailersMaker h2rsp maker

data NextTrailersMaker Source #

Either the next trailers maker or final trailers.

Constructors

NextTrailersMaker TrailersMaker
Trailers [Header]

defaultTrailersMaker :: TrailersMaker Source #

TrailersMake to create no trailers.

runTrailersMaker :: TrailersMaker -> Buffer -> Int -> IO NextTrailersMaker Source #

Running trailers-maker.

bufferIO buf siz $ \bs -> tlrmkr (Just bs)