| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.HTTP.Semantics.Client
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 ()
- outBodyCancel :: Maybe SomeException -> IO ()
- outBodyFlush :: IO ()
- requestStreamingIface :: Method -> Path -> RequestHeaders -> (OutBodyIface -> IO ()) -> Request
- type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker
- data NextTrailersMaker
- 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
- defaultPositionReadMaker :: PositionReadMaker
HTTP 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.
Request
Request from client.
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.
requestStreamingUnmask :: Method -> Path -> RequestHeaders -> ((forall x. IO x -> IO x) -> (Builder -> IO ()) -> IO () -> IO ()) -> Request #
Like requestStreaming, but run the action with exceptions masked
requestBuilder :: Method -> Path -> RequestHeaders -> Builder -> Request #
Creating request with builder.
Generalized streaming interface
data OutBodyIface #
Constructors
| OutBodyIface | |
Fields
| |
requestStreamingIface :: Method -> Path -> RequestHeaders -> (OutBodyIface -> IO ()) -> Request #
Generalized version of requestStreaming,
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 bsUsage example:
let h2rsp = responseFile ...
maker = trailersMaker (CH.hashInit :: Context SHA1)
h2rsp' = setResponseTrailersMaker h2rsp makerdata 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
Response from server.
Accessing response
responseStatus :: Response -> Maybe Status #
Getting the status of a response.
responseHeaders :: Response -> TokenHeaderTable #
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.
getResponseBodyChunk' :: Response -> IO (ByteString, Bool) #
Generalization of getResponseBodyChunk which also returns if the ByteString is the final one
getResponseTrailers :: Response -> IO (Maybe TokenHeaderTable) #
Reading response trailers.
This function must be called after getResponseBodyChunk
returns an empty.
Aux
auxPossibleClientStreams :: Aux -> IO Int #
How many streams can be created without blocking.
Types
type Scheme = ByteString #
"http" or "https".
type Method = ByteString #
HTTP method (flat ByteString type).
type Path = ByteString #
Path.
File specification.
Constructors
| FileSpec FilePath FileOffset ByteCount |
type FileOffset = Int64 #
Offset for file.
type ReadN = Int -> IO ByteString #
Reading n bytes.
defaultReadN :: Socket -> IORef (Maybe ByteString) -> ReadN #
Naive implementation for readN.
NOTE: This function is intended to be used by a single thread only. (It is probably quite rare anyway to want concurrent reads from the same network socket.)
type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount #
Position read for files.
type PositionReadMaker = FilePath -> IO (PositionRead, Sentinel) #
Making a position read and its closer.
defaultPositionReadMaker :: PositionReadMaker #
Position read based on Handle.