Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.HTTP3.Client

Contents

Runner
Runner arguments
HTTP/3 client
Request
Creating request
- Trailers maker
Response
- Accessing response
Types
RecvN
Position read for files

Description

A client library for HTTP/3.

Synopsis

run :: Connection -> ClientConfig -> Config -> Client a -> IO a
data ClientConfig = ClientConfig {
- scheme :: Scheme
- authority :: Authority
}
data Config = Config {
- confHooks :: Hooks
- confPositionReadMaker :: PositionReadMaker
- confTimeoutManager :: Manager
}
allocSimpleConfig :: IO Config
freeSimpleConfig :: Config -> IO ()
data Hooks = Hooks {
- onControlFrameCreated :: [H3Frame] -> [H3Frame]
- onHeadersFrameCreated :: [H3Frame] -> [H3Frame]
- onControlStreamCreated :: Stream -> IO ()
- onEncoderStreamCreated :: Stream -> IO ()
- onDecoderStreamCreated :: Stream -> IO ()
}
defaultHooks :: Hooks
type Scheme = ByteString
type Authority = String
type Client a = SendRequest -> Aux -> IO a
type SendRequest = forall r. Request -> (Response -> IO r) -> IO r
data Aux
data Request
requestNoBody :: Method -> Path -> RequestHeaders -> Request
requestFile :: Method -> Path -> RequestHeaders -> FileSpec -> Request
requestStreaming :: Method -> Path -> RequestHeaders -> ((Builder -> IO ()) -> IO () -> IO ()) -> Request
requestBuilder :: Method -> Path -> RequestHeaders -> Builder -> Request
type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker
data NextTrailersMaker
- = NextTrailersMaker TrailersMaker
- | Trailers [Header]
defaultTrailersMaker :: TrailersMaker
setRequestTrailersMaker :: Request -> TrailersMaker -> Request
data Response
responseStatus :: Response -> Maybe Status
responseHeaders :: Response -> HeaderTable
responseBodySize :: Response -> Maybe Int
getResponseBodyChunk :: Response -> IO ByteString
getResponseTrailers :: Response -> IO (Maybe HeaderTable)
type Method = ByteString
type Path = ByteString
data FileSpec = FileSpec FilePath FileOffset ByteCount
type FileOffset = Int64
type ByteCount = Int64
defaultReadN :: Socket -> IORef (Maybe ByteString) -> Int -> IO ByteString
type PositionReadMaker = FilePath -> IO (PositionRead, Sentinel)
type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount
data Sentinel
- = Closer (IO ())
- | Refresher (IO ())
defaultPositionReadMaker :: PositionReadMaker

Runner

run :: Connection -> ClientConfig -> Config -> Client a -> IO a Source #

Running an HTTP/3 client.

Runner arguments

data ClientConfig Source #

Configuration for HTTP/3 or HQ client. For HQ, authority is not used and an server's IP address is used in Request.

Constructors

ClientConfig
Fields scheme :: Scheme authority :: Authority

data Config Source #

Configuration for HTTP/3 or HQ.

Constructors

Config
Fields confHooks :: Hooks confPositionReadMaker :: PositionReadMaker confTimeoutManager :: Manager

allocSimpleConfig :: IO Config Source #

Allocating a simple configuration with a handle-based position reader and a locally allocated timeout manager.

freeSimpleConfig :: Config -> IO () Source #

Freeing a simple configration.

data Hooks Source #

Hooks mainly for error testing.

Constructors

Hooks
Fields onControlFrameCreated :: [H3Frame] -> [H3Frame] onHeadersFrameCreated :: [H3Frame] -> [H3Frame] onControlStreamCreated :: Stream -> IO () onEncoderStreamCreated :: Stream -> IO () onDecoderStreamCreated :: Stream -> IO ()

defaultHooks :: Hooks Source #

Default hooks.

type Scheme = ByteString #

"http" or "https".

type Authority = String #

Authority.

HTTP/3 client

type Client a = SendRequest -> Aux -> IO a #

Client type.

type SendRequest = forall r. Request -> (Response -> IO r) -> IO r #

Send a request and receive its response.

data Aux #

Additional information.

Request

data Request #

Request from client.

Instances

Instances details

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

Creating request

requestNoBody :: Method -> Path -> RequestHeaders -> Request #

Creating request without body.

requestFile :: Method -> Path -> RequestHeaders -> FileSpec -> Request #

Creating request with file.

requestStreaming :: Method -> Path -> RequestHeaders -> ((Builder -> IO ()) -> IO () -> IO ()) -> Request #

Creating request with streaming.

requestBuilder :: Method -> Path -> RequestHeaders -> Builder -> Request #

Creating request with builder.

Trailers maker

type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker #

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 #

Either the next trailers maker or final trailers.

Constructors

NextTrailersMaker TrailersMaker
Trailers [Header]

defaultTrailersMaker :: TrailersMaker #

TrailersMake to create no trailers.

setRequestTrailersMaker :: Request -> TrailersMaker -> Request #

Setting TrailersMaker to Response.

Response

data Response #

Response from server.

Instances

Instances details

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

Accessing response

responseStatus :: Response -> Maybe Status #

Getting the status of a response.

responseHeaders :: Response -> HeaderTable #

Getting the headers from a response.

responseBodySize :: Response -> Maybe Int #

Getting the body size from a response.

getResponseBodyChunk :: Response -> IO ByteString #

Reading a chunk of the response body. An empty ByteString returned when finished.

getResponseTrailers :: Response -> IO (Maybe HeaderTable) #

Reading response trailers. This function must be called after getResponseBodyChunk returns an empty.

Types

type Method = ByteString #

HTTP method (flat ByteString type).

type Path = ByteString #

Path.

data FileSpec #

File specification.

Constructors

FileSpec FilePath FileOffset ByteCount

Instances

Instances details

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

type FileOffset = Int64 #

Offset for file.

type ByteCount = Int64 #

How many bytes to read

RecvN

defaultReadN :: Socket -> IORef (Maybe ByteString) -> Int -> IO ByteString #

Naive implementation for readN.

Position read for files

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

Making a position read and its closer.

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

Position read for files.

data Sentinel #

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.

defaultPositionReadMaker :: PositionReadMaker #

Position read based on Handle.