Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.HTTP.Semantics.Client

Contents

HTTP client
Request
Creating request
- Generalized streaming interface
- Trailers maker
Response
- Accessing response
Aux
Types
Reading n bytes
Position read

Synopsis

type Client a = SendRequest -> Aux -> IO a
type SendRequest = forall r. Request -> (Response -> IO r) -> IO r
data Request
requestNoBody :: Method -> Path -> RequestHeaders -> Request
requestFile :: Method -> Path -> RequestHeaders -> FileSpec -> Request
requestStreaming :: Method -> Path -> RequestHeaders -> ((Builder -> IO ()) -> IO () -> IO ()) -> Request
requestStreamingUnmask :: Method -> Path -> RequestHeaders -> ((forall x. IO x -> IO x) -> (Builder -> IO ()) -> IO () -> IO ()) -> Request
requestBuilder :: Method -> Path -> RequestHeaders -> Builder -> Request
data OutBodyIface = OutBodyIface {
- outBodyUnmask :: forall x. IO x -> IO x
- outBodyPush :: Builder -> IO ()
- outBodyPushFinal :: Builder -> IO ()
- outBodyFlush :: IO ()
}
requestStreamingIface :: Method -> Path -> RequestHeaders -> (OutBodyIface -> IO ()) -> 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 -> TokenHeaderTable
responseBodySize :: Response -> Maybe Int
getResponseBodyChunk :: Response -> IO ByteString
getResponseBodyChunk' :: Response -> IO (ByteString, Bool)
getResponseTrailers :: Response -> IO (Maybe TokenHeaderTable)
data Aux
auxPossibleClientStreams :: Aux -> IO Int
type Scheme = ByteString
type Authority = String
type Method = ByteString
type Path = ByteString
data FileSpec = FileSpec FilePath FileOffset ByteCount
type FileOffset = Int64
type ByteCount = Int64
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

HTTP client

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

Client type.

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

Send a request and receive its response.

Request

data Request Source #

Request from client.

Instances

Instances details

Show Request Source #
Instance details Defined in Network.HTTP.Semantics.Client.Internal Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #

Creating request

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

Creating request without body.

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

Creating request with file.

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

Creating request with streaming.

requestStreamingUnmask :: Method -> Path -> RequestHeaders -> ((forall x. IO x -> IO x) -> (Builder -> IO ()) -> IO () -> IO ()) -> Request Source #

Like requestStreaming, but run the action with exceptions masked

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

Creating request with builder.

Generalized streaming interface

data OutBodyIface Source #

Constructors

OutBodyIface

Fields

outBodyUnmask :: forall x. IO x -> IO x
Unmask exceptions in the thread spawned for the request body
outBodyPush :: Builder -> IO ()
Push a new chunk
outBodyPushFinal :: Builder -> IO ()
Push the final chunk
Using this function instead of outBodyPush can be used to guarantee that the final HTTP2 DATA frame is marked end-of-stream; with outBodyPush it may happen that an additional empty DATA frame is used for this purpose.
outBodyFlush :: IO ()
Flush

requestStreamingIface :: Method -> Path -> RequestHeaders -> (OutBodyIface -> IO ()) -> Request Source #

Generalized version of requestStreaming,

Trailers maker

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.

setRequestTrailersMaker :: Request -> TrailersMaker -> Request Source #

Setting TrailersMaker to Response.

Response

data Response Source #

Response from server.

Instances

Instances details

Show Response Source #
Instance details Defined in Network.HTTP.Semantics.Client.Internal Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #

Accessing response

responseStatus :: Response -> Maybe Status Source #

Getting the status of a response.

responseHeaders :: Response -> TokenHeaderTable Source #

Getting the headers from a response.

responseBodySize :: Response -> Maybe Int Source #

Getting the body size from a response.

getResponseBodyChunk :: Response -> IO ByteString Source #

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

getResponseBodyChunk' :: Response -> IO (ByteString, Bool) Source #

Generalization of getResponseBodyChunk which also returns if the ByteString is the final one

getResponseTrailers :: Response -> IO (Maybe TokenHeaderTable) Source #

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

Aux

data Aux Source #

Additional information.

auxPossibleClientStreams :: Aux -> IO Int Source #

How many streams can be created without blocking.

Types

type Scheme = ByteString Source #

"http" or "https".

type Authority = String Source #

Authority.

type Method = ByteString Source #

HTTP method (flat ByteString type).

type Path = ByteString Source #

Path.

data FileSpec Source #

File specification.

Constructors

FileSpec FilePath FileOffset ByteCount

Instances

Instances details

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

type FileOffset = Int64 Source #

Offset for file.

type ByteCount = Int64 Source #

How many bytes to read

Reading n bytes

type ReadN = Int -> IO ByteString Source #

Reading n bytes.

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

Naive implementation for readN.

Position read

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.