Safe Haskell	None
Language	Haskell2010

Network.HTTP2.Internal

Contents

File
Types
Request and response
Sender
Trailer

Synopsis

type FileOffset = Int64
type ByteCount = Int64
type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount
data Sentinel
- = Closer ( IO ())
- | Refresher ( IO ())
type PositionReadMaker = FilePath -> IO ( PositionRead , Sentinel )
defaultPositionReadMaker :: PositionReadMaker
type Scheme = ByteString
type Authority = ByteString
type Path = ByteString
data InpObj = InpObj {
- inpObjHeaders :: HeaderTable
- inpObjBodySize :: Maybe Int
- inpObjBody :: InpBody
- inpObjTrailers :: IORef ( Maybe HeaderTable )
}
type InpBody = IO ByteString
data OutObj = OutObj {
- outObjHeaders :: [ Header ]
- outObjBody :: OutBody
- outObjTrailers :: TrailersMaker
}
data OutBody
- = OutBodyNone
- | OutBodyStreaming (( Builder -> IO ()) -> IO () -> IO ())
- | OutBodyBuilder Builder
- | OutBodyFile FileSpec
data FileSpec = FileSpec FilePath FileOffset ByteCount
data Next = Next BytesFilled ( Maybe DynaNext )
type BytesFilled = Int
type DynaNext = Buffer -> BufferSize -> WindowSize -> IO Next
data StreamingChunk
- = StreamingFinished
- | StreamingFlush
- | StreamingBuilder Builder
fillBuilderBodyGetNext :: Builder -> DynaNext
fillFileBodyGetNext :: PositionRead -> FileOffset -> ByteCount -> IO () -> DynaNext
fillStreamBodyGetNext :: IO ( Maybe StreamingChunk ) -> DynaNext
type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker
defaultTrailersMaker :: TrailersMaker
data NextTrailersMaker
- = NextTrailersMaker TrailersMaker
- | Trailers [ Header ]
runTrailersMaker :: TrailersMaker -> Buffer -> Int -> IO NextTrailersMaker

File

type FileOffset = Int64 Source #

Offset for file.

type ByteCount = Int64 Source #

How many bytes to read

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

Position read for files.

data Sentinel Source #

Manipulating a file resource.

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.

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

Making a position read and its closer.

defaultPositionReadMaker :: PositionReadMaker Source #

Position read based on Handle .

Types

type Scheme = ByteString Source #

"http" or "https".

type Authority = ByteString Source #

For so-called "Host:" header.

type Path = ByteString Source #

Path.

Request and response

data InpObj Source #

Input object

Constructors

InpObj
Fields inpObjHeaders :: HeaderTable Accessor for headers. inpObjBodySize :: Maybe Int Accessor for body length specified in content-length:. inpObjBody :: InpBody Accessor for body. inpObjTrailers :: IORef ( Maybe HeaderTable ) Accessor for trailers.

Instances

Instances details

Show InpObj Source #
Instance details Defined in Network.HTTP2.Arch.Types Methods showsPrec :: Int -> InpObj -> ShowS Source # show :: InpObj -> String Source # showList :: [ InpObj ] -> ShowS Source #

type InpBody = IO ByteString Source #

data OutObj Source #

Output object

Constructors

OutObj
Fields outObjHeaders :: [ Header ] Accessor for header. outObjBody :: OutBody Accessor for outObj body. outObjTrailers :: TrailersMaker Accessor for trailers maker.

Instances

Instances details

Show OutObj Source #
Instance details Defined in Network.HTTP2.Arch.Types Methods showsPrec :: Int -> OutObj -> ShowS Source # show :: OutObj -> String Source # showList :: [ OutObj ] -> ShowS Source #

data OutBody Source #

Constructors

OutBodyNone
OutBodyStreaming (( Builder -> IO ()) -> IO () -> IO ())	Streaming body takes a write action and a flush action.
OutBodyBuilder Builder
OutBodyFile FileSpec

data FileSpec Source #

File specification.

Constructors

FileSpec FilePath FileOffset ByteCount

Instances

Instances details

Eq FileSpec Source #
Instance details Defined in Network.HTTP2.Arch.Types Methods (==) :: FileSpec -> FileSpec -> Bool Source # (/=) :: FileSpec -> FileSpec -> Bool Source #
Show FileSpec Source #
Instance details Defined in Network.HTTP2.Arch.Types Methods showsPrec :: Int -> FileSpec -> ShowS Source # show :: FileSpec -> String Source # showList :: [ FileSpec ] -> ShowS Source #

Sender

data Next Source #

Constructors

Next BytesFilled ( Maybe DynaNext )

type BytesFilled = Int Source #

type DynaNext = Buffer -> BufferSize -> WindowSize -> IO Next Source #

data StreamingChunk Source #

Constructors

StreamingFinished
StreamingFlush
StreamingBuilder Builder

fillBuilderBodyGetNext :: Builder -> DynaNext Source #

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

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

Trailer

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

defaultTrailersMaker :: TrailersMaker Source #

TrailersMake to create no trailers.

data NextTrailersMaker Source #

Either the next trailers maker or final trailers.

Constructors

NextTrailersMaker TrailersMaker
Trailers [ Header ]

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

Running trailers-maker.

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