Safe Haskell | Trustworthy |
---|---|
Language | Haskell2010 |
Provides an HTTP(S) client via http-client(-tls) in a Magicbane app context. Also provides a simple composable interface for making arbitrary requests, based on http-client-conduit. That lets you plug stream parsers (e.g. html-conduit: 'performWithFn (.| sinkDoc)') directly into the reading of the response body.
Synopsis
- type MonadHTTP ψ μ = (HasHttpManager ψ, MonadReader ψ μ, MonadUnliftIO μ)
- newtype ModHttpClient = ModHttpClient Manager
- newHttpClient :: IO ModHttpClient
- runHTTP :: ExceptT ε μ α -> μ (Either ε α)
- reqU :: MonadHTTP ψ μ => URI -> ExceptT Text μ Request
- reqS :: (MonadHTTP ψ μ, ConvertibleStrings σ String) => σ -> ExceptT Text μ Request
- anyStatus :: MonadHTTP ψ μ => Request -> ExceptT Text μ Request
- postForm :: MonadHTTP ψ μ => [(Text, Text)] -> Request -> ExceptT Text μ Request
- postJson :: (MonadHTTP ψ μ, ToJSON α) => α -> Request -> ExceptT Text μ Request
- performWithFn :: (MonadHTTP ψ μ, MonadCatch μ) => (ConduitM ι ByteString μ () -> ConduitT () Void μ ρ) -> Request -> ExceptT Text μ (Response ρ)
- performWithVoid :: (MonadHTTP ψ μ, MonadCatch μ) => Request -> ExceptT Text μ (Response ())
- performWithBytes :: (MonadHTTP ψ μ, MonadCatch μ) => Request -> ExceptT Text μ (Response ByteString)
- applyHeaders :: RequestHeaders -> Request -> Request
- removeHeaders :: [HeaderName] -> Request -> Request
- newtype ExceptT e (m :: * -> *) a = ExceptT (m (Either e a))
- class MonadIO m => MonadUnliftIO (m :: * -> *)
- runExceptT :: ExceptT e m a -> m (Either e a)
- class MonadThrow m => MonadCatch (m :: * -> *)
- data URI = URI {}
- responseTimeoutDefault :: ResponseTimeout
- responseTimeoutNone :: ResponseTimeout
- responseTimeoutMicro :: Int -> ResponseTimeout
- managerSetProxy :: ProxyOverride -> ManagerSettings -> ManagerSettings
- managerSetSecureProxy :: ProxyOverride -> ManagerSettings -> ManagerSettings
- managerSetInsecureProxy :: ProxyOverride -> ManagerSettings -> ManagerSettings
- withResponseHistory :: Request -> Manager -> (HistoriedResponse BodyReader -> IO a) -> IO a
- responseOpenHistory :: Request -> Manager -> IO (HistoriedResponse BodyReader)
- data HistoriedResponse body
- withConnection :: Request -> Manager -> (Connection -> IO a) -> IO a
- responseClose :: Response a -> IO ()
- responseOpen :: Request -> Manager -> IO (Response BodyReader)
- httpNoBody :: Request -> Manager -> IO (Response ())
- httpLbs :: Request -> Manager -> IO (Response ByteString)
- withResponse :: Request -> Manager -> (Response BodyReader -> IO a) -> IO a
- generateCookie :: SetCookie -> Request -> UTCTime -> Bool -> Maybe Cookie
- insertCheckedCookie :: Cookie -> CookieJar -> Bool -> CookieJar
- receiveSetCookie :: SetCookie -> Request -> UTCTime -> Bool -> CookieJar -> CookieJar
- updateCookieJar :: Response a -> Request -> UTCTime -> CookieJar -> (CookieJar, Response a)
- computeCookieString :: Request -> CookieJar -> UTCTime -> Bool -> (ByteString, CookieJar)
- insertCookiesIntoRequest :: Request -> CookieJar -> UTCTime -> (Request, CookieJar)
- evictExpiredCookies :: CookieJar -> UTCTime -> CookieJar
- removeExistingCookieFromCookieJar :: Cookie -> CookieJar -> (Maybe Cookie, CookieJar)
- destroyCookieJar :: CookieJar -> [Cookie]
- createCookieJar :: [Cookie] -> CookieJar
- pathMatches :: ByteString -> ByteString -> Bool
- defaultPath :: Request -> ByteString
- domainMatches :: ByteString -> ByteString -> Bool
- isIpAddress :: ByteString -> Bool
- defaultProxy :: ProxyOverride
- proxyEnvironmentNamed :: Text -> Maybe Proxy -> ProxyOverride
- proxyEnvironment :: Maybe Proxy -> ProxyOverride
- useProxy :: Proxy -> ProxyOverride
- noProxy :: ProxyOverride
- proxyFromRequest :: ProxyOverride
- withManager :: ManagerSettings -> (Manager -> IO a) -> IO a
- closeManager :: Manager -> IO ()
- newManager :: ManagerSettings -> IO Manager
- defaultManagerSettings :: ManagerSettings
- rawConnectionModifySocketSize :: (Socket -> IO ()) -> IO (Int -> Maybe HostAddress -> String -> Int -> IO Connection)
- rawConnectionModifySocket :: (Socket -> IO ()) -> IO (Maybe HostAddress -> String -> Int -> IO Connection)
- observedStreamFile :: (StreamFileStatus -> IO ()) -> FilePath -> IO RequestBody
- streamFile :: FilePath -> IO RequestBody
- setQueryStringPartialEscape :: [(ByteString, [EscapeItem])] -> Request -> Request
- setQueryString :: [(ByteString, Maybe ByteString)] -> Request -> Request
- setRequestCheckStatus :: Request -> Request
- setRequestIgnoreStatus :: Request -> Request
- urlEncodedBody :: [(ByteString, ByteString)] -> Request -> Request
- applyBasicProxyAuth :: ByteString -> ByteString -> Request -> Request
- applyBasicAuth :: ByteString -> ByteString -> Request -> Request
- defaultRequest :: Request
- getUri :: Request -> URI
- requestFromURI_ :: URI -> Request
- requestFromURI :: MonadThrow m => URI -> m Request
- parseRequest_ :: String -> Request
- parseRequest :: MonadThrow m => String -> m Request
- throwErrorStatusCodes :: MonadIO m => Request -> Response BodyReader -> m ()
- parseUrlThrow :: MonadThrow m => String -> m Request
- parseUrl :: MonadThrow m => String -> m Request
- brConsume :: BodyReader -> IO [ByteString]
- brReadSome :: BodyReader -> Int -> IO ByteString
- brRead :: BodyReader -> IO ByteString
- socketConnection :: Socket -> Int -> IO Connection
- makeConnection :: IO ByteString -> (ByteString -> IO ()) -> IO () -> IO Connection
- type BodyReader = IO ByteString
- data HttpException
- data HttpExceptionContent
- = StatusCodeException (Response ()) ByteString
- | TooManyRedirects [Response ByteString]
- | OverlongHeaders
- | ResponseTimeout
- | ConnectionTimeout
- | ConnectionFailure SomeException
- | InvalidStatusLine ByteString
- | InvalidHeader ByteString
- | InternalException SomeException
- | ProxyConnectException ByteString Int Status
- | NoResponseDataReceived
- | TlsNotSupported
- | WrongRequestBodyStreamSize Word64 Word64
- | ResponseBodyTooShort Word64 Word64
- | InvalidChunkHeaders
- | IncompleteHeaders
- | InvalidDestinationHost ByteString
- | HttpZlibException ZlibException
- | InvalidProxyEnvironmentVariable Text Text
- | ConnectionClosed
- | InvalidProxySettings Text
- data Cookie = Cookie {}
- data CookieJar
- proxyHost :: Proxy -> ByteString
- proxyPort :: Proxy -> Int
- data RequestBody
- type Popper = IO ByteString
- type NeedsPopper a = Popper -> IO a
- type GivesPopper a = NeedsPopper a -> IO a
- data Request
- data ResponseTimeout
- data Response body
- data ManagerSettings
- data ProxyOverride
- data Manager
- class HasHttpManager a where
- data StreamFileStatus = StreamFileStatus {}
- fragment :: URI -> String
- query :: URI -> String
- path :: URI -> String
- authority :: URI -> String
- scheme :: URI -> String
- unreserved :: Char -> Bool
- reserved :: Char -> Bool
- escapeString :: String -> (Char -> Bool) -> String
- parseabsoluteURI :: String -> Maybe URI
- normalizePathSegments :: String -> String
- normalizeEscape :: String -> String
- normalizeCase :: String -> String
- relativeFrom :: URI -> URI -> URI
- pathSegments :: URI -> [String]
- relativeTo :: URI -> URI -> URI
- nonStrictRelativeTo :: URI -> URI -> URI
- unEscapeString :: String -> String
- escapeURIString :: (Char -> Bool) -> String -> String
- escapeURIChar :: (Char -> Bool) -> Char -> String
- isUnescapedInURIComponent :: Char -> Bool
- isUnescapedInURI :: Char -> Bool
- isAllowedInURI :: Char -> Bool
- uriToString :: (String -> String) -> URI -> ShowS
- isUnreserved :: Char -> Bool
- isReserved :: Char -> Bool
- uriIsRelative :: URI -> Bool
- uriIsAbsolute :: URI -> Bool
- isIPv4address :: String -> Bool
- isIPv6address :: String -> Bool
- isAbsoluteURI :: String -> Bool
- isRelativeReference :: String -> Bool
- isURIReference :: String -> Bool
- isURI :: String -> Bool
- parseAbsoluteURI :: String -> Maybe URI
- parseRelativeReference :: String -> Maybe URI
- parseURIReference :: String -> Maybe URI
- parseURI :: String -> Maybe URI
- nullURI :: URI
- data URIAuth = URIAuth {
- uriUserInfo :: String
- uriRegName :: String
- uriPort :: String
Documentation
type MonadHTTP ψ μ = (HasHttpManager ψ, MonadReader ψ μ, MonadUnliftIO μ) Source #
newtype ModHttpClient Source #
reqS :: (MonadHTTP ψ μ, ConvertibleStrings σ String) => σ -> ExceptT Text μ Request Source #
Creates a request from a string of any type, parsing it into a URI.
anyStatus :: MonadHTTP ψ μ => Request -> ExceptT Text μ Request Source #
Configures the request to not throw errors on error status codes.
postForm :: MonadHTTP ψ μ => [(Text, Text)] -> Request -> ExceptT Text μ Request Source #
Sets a x-www-form-urlencoded form as the request body (also sets the content-type).
postJson :: (MonadHTTP ψ μ, ToJSON α) => α -> Request -> ExceptT Text μ Request Source #
Sets a JSON value as the request body (via ToJSON; also sets the content-type).
performWithFn :: (MonadHTTP ψ μ, MonadCatch μ) => (ConduitM ι ByteString μ () -> ConduitT () Void μ ρ) -> Request -> ExceptT Text μ (Response ρ) Source #
Performs the request, using a given function to read the body. This is what all other performWith functions are based on.
performWithVoid :: (MonadHTTP ψ μ, MonadCatch μ) => Request -> ExceptT Text μ (Response ()) Source #
Performs the request, ignoring the body.
performWithBytes :: (MonadHTTP ψ μ, MonadCatch μ) => Request -> ExceptT Text μ (Response ByteString) Source #
Performs the request, reading the body into a lazy ByteString.
applyHeaders :: RequestHeaders -> Request -> Request Source #
Add headers to the request, preserving any existing headers not specified in the new set.
removeHeaders :: [HeaderName] -> Request -> Request Source #
Remove listed headers from the request.
newtype ExceptT e (m :: * -> *) a #
A monad transformer that adds exceptions to other monads.
ExceptT
constructs a monad parameterized over two things:
- e - The exception type.
- m - The inner monad.
The return
function yields a computation that produces the given
value, while >>=
sequences two subcomputations, exiting on the
first exception.
Instances
class MonadIO m => MonadUnliftIO (m :: * -> *) #
Monads which allow their actions to be run in IO
.
While MonadIO
allows an IO
action to be lifted into another
monad, this class captures the opposite concept: allowing you to
capture the monadic context. Note that, in order to meet the laws
given below, the intuition is that a monad must have no monadic
state, but may have monadic context. This essentially limits
MonadUnliftIO
to ReaderT
and IdentityT
transformers on top of
IO
.
Laws. For any value u
returned by askUnliftIO
, it must meet the
monad transformer laws as reformulated for MonadUnliftIO
:
unliftIO u . return = return
unliftIO u (m >>= f) = unliftIO u m >>= unliftIO u . f
The third is a currently nameless law which ensures that the current context is preserved.
askUnliftIO >>= (u -> liftIO (unliftIO u m)) = m
If you have a name for this, please submit it in a pull request for great glory.
Since: unliftio-core-0.1.0.0
Instances
MonadUnliftIO IO | |
Defined in Control.Monad.IO.Unlift | |
MonadUnliftIO m => MonadUnliftIO (ResourceT m) | Since: resourcet-1.1.10 |
Defined in Control.Monad.Trans.Resource.Internal | |
MonadUnliftIO m => MonadUnliftIO (NoLoggingT m) | Since: monad-logger-0.3.26 |
Defined in Control.Monad.Logger askUnliftIO :: NoLoggingT m (UnliftIO (NoLoggingT m)) # withRunInIO :: ((forall a. NoLoggingT m a -> IO a) -> IO b) -> NoLoggingT m b # | |
MonadUnliftIO m => MonadUnliftIO (LoggingT m) | Since: monad-logger-0.3.26 |
Defined in Control.Monad.Logger | |
MonadUnliftIO (RIO env) | |
Defined in RIO.Prelude.RIO | |
MonadUnliftIO m => MonadUnliftIO (IdentityT m) | |
Defined in Control.Monad.IO.Unlift | |
MonadUnliftIO m => MonadUnliftIO (ReaderT r m) | |
Defined in Control.Monad.IO.Unlift |
runExceptT :: ExceptT e m a -> m (Either e a) #
The inverse of ExceptT
.
class MonadThrow m => MonadCatch (m :: * -> *) #
A class for monads which allow exceptions to be caught, in particular
exceptions which were thrown by throwM
.
Instances should obey the following law:
catch (throwM e) f = f e
Note that the ability to catch an exception does not guarantee that we can
deal with all possible exit points from a computation. Some monads, such as
continuation-based stacks, allow for more than just a success/failure
strategy, and therefore catch
cannot be used by those monads to properly
implement a function such as finally
. For more information, see
MonadMask
.
Instances
Represents a general universal resource identifier using its component parts.
For example, for the URI
foo://anonymous@www.haskell.org:42/ghc?query#frag
the components are:
Instances
Eq URI | |
Data URI | |
Defined in Network.URI gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URI -> c URI # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URI # dataTypeOf :: URI -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URI) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URI) # gmapT :: (forall b. Data b => b -> b) -> URI -> URI # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URI -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URI -> r # gmapQ :: (forall d. Data d => d -> u) -> URI -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> URI -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> URI -> m URI # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URI -> m URI # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URI -> m URI # | |
Ord URI | |
Show URI | |
Generic URI | |
NFData URI | |
Defined in Network.URI | |
type Rep URI | |
Defined in Network.URI type Rep URI = D1 (MetaData "URI" "Network.URI" "network-uri-2.6.1.0-AstEwZoXrlUJQq4VkxaVo9" False) (C1 (MetaCons "URI" PrefixI True) ((S1 (MetaSel (Just "uriScheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "uriAuthority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URIAuth))) :*: (S1 (MetaSel (Just "uriPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "uriQuery") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "uriFragment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))) |
responseTimeoutDefault :: ResponseTimeout #
Use the default response timeout
When used on a Request
, means: use the manager's timeout value
When used on a ManagerSettings
, means: default to 30 seconds
Since: http-client-0.5.0
responseTimeoutNone :: ResponseTimeout #
Do not have a response timeout
Since: http-client-0.5.0
responseTimeoutMicro :: Int -> ResponseTimeout #
Specify a response timeout in microseconds
Since: http-client-0.5.0
managerSetProxy :: ProxyOverride -> ManagerSettings -> ManagerSettings #
Set the proxy override value, for both HTTP (insecure) and HTTPS (insecure) connections.
Since 0.4.7
managerSetSecureProxy :: ProxyOverride -> ManagerSettings -> ManagerSettings #
Set the proxy override value, only for HTTPS (secure) connections.
Since 0.4.7
managerSetInsecureProxy :: ProxyOverride -> ManagerSettings -> ManagerSettings #
Set the proxy override value, only for HTTP (insecure) connections.
Since 0.4.7
withResponseHistory :: Request -> Manager -> (HistoriedResponse BodyReader -> IO a) -> IO a #
A variant of withResponse
which keeps a history of all redirects
performed in the interim, together with the first 1024 bytes of their
response bodies.
Since 0.4.1
responseOpenHistory :: Request -> Manager -> IO (HistoriedResponse BodyReader) #
A variant of responseOpen
which keeps a history of all redirects
performed in the interim, together with the first 1024 bytes of their
response bodies.
Since 0.4.1
data HistoriedResponse body #
A datatype holding information on redirected requests and the final response.
Since 0.4.1
Instances
withConnection :: Request -> Manager -> (Connection -> IO a) -> IO a #
Perform an action using a Connection
acquired from the given Manager
.
You should use this only when you have to read and write interactively through the connection (e.g. connection by the WebSocket protocol).
Since: http-client-0.5.13
responseClose :: Response a -> IO () #
Close any open resources associated with the given Response
. In general,
this will either close an active Connection
or return it to the Manager
to be reused.
Since 0.1.0
responseOpen :: Request -> Manager -> IO (Response BodyReader) #
The most low-level function for initiating an HTTP request.
The first argument to this function gives a full specification
on the request: the host to connect to, whether to use SSL,
headers, etc. Please see Request
for full details. The
second argument specifies which Manager
should be used.
This function then returns a Response
with a
BodyReader
. The Response
contains the status code
and headers that were sent back to us, and the
BodyReader
contains the body of the request. Note
that this BodyReader
allows you to have fully
interleaved IO actions during your HTTP download, making it
possible to download very large responses in constant memory.
An important note: the response body returned by this function represents a
live HTTP connection. As such, if you do not use the response body, an open
socket will be retained indefinitely. You must be certain to call
responseClose
on this response to free up resources.
This function automatically performs any necessary redirects, as specified
by the redirectCount
setting.
When implementing a (reverse) proxy using this function or relating functions, it's wise to remove Transfer-Encoding:, Content-Length:, Content-Encoding: and Accept-Encoding: from request and response headers to be relayed.
Since 0.1.0
httpNoBody :: Request -> Manager -> IO (Response ()) #
A convenient wrapper around withResponse
which ignores the response
body. This is useful, for example, when performing a HEAD request.
Since 0.3.2
httpLbs :: Request -> Manager -> IO (Response ByteString) #
A convenience wrapper around withResponse
which reads in the entire
response body and immediately closes the connection. Note that this function
performs fully strict I/O, and only uses a lazy ByteString in its response
for memory efficiency. If you are anticipating a large response body, you
are encouraged to use withResponse
and brRead
instead.
Since 0.1.0
withResponse :: Request -> Manager -> (Response BodyReader -> IO a) -> IO a #
Perform a Request
using a connection acquired from the given Manager
,
and then provide the Response
to the given function. This function is
fully exception safe, guaranteeing that the response will be closed when the
inner function exits. It is defined as:
withResponse req man f = bracket (responseOpen req man) responseClose f
It is recommended that you use this function in place of explicit calls to
responseOpen
and responseClose
.
You will need to use functions such as brRead
to consume the response
body.
Since 0.1.0
:: SetCookie | The |
-> Request | The request that originated the response that yielded the |
-> UTCTime | Value that should be used as "now" |
-> Bool | Whether or not this request is coming from an "http" source (not javascript or anything like that) |
-> Maybe Cookie | The optional output cookie |
Turn a SetCookie into a Cookie, if it is valid
:: Cookie | The |
-> CookieJar | Input cookie jar to modify |
-> Bool | Whether or not this request is coming from an "http" source (not javascript or anything like that) |
-> CookieJar | Updated (or not) cookie jar |
Insert a cookie created by generateCookie into the cookie jar (or not if it shouldn't be allowed in)
:: SetCookie | The |
-> Request | The request that originated the response that yielded the |
-> UTCTime | Value that should be used as "now" |
-> Bool | Whether or not this request is coming from an "http" source (not javascript or anything like that) |
-> CookieJar | Input cookie jar to modify |
-> CookieJar | Updated cookie jar |
This corresponds to the algorithm described in Section 5.3 "Storage Model"
This function consists of calling generateCookie
followed by insertCheckedCookie
.
Use this function if you plan to do both in a row.
generateCookie
and insertCheckedCookie
are only provided for more fine-grained control.
:: Response a | Response received from server |
-> Request | Request which generated the response |
-> UTCTime | Value that should be used as "now" |
-> CookieJar | Current cookie jar |
-> (CookieJar, Response a) | (Updated cookie jar with cookies from the Response, The response stripped of any "Set-Cookie" header) |
This applies receiveSetCookie
to a given Response
:: Request | Input request |
-> CookieJar | Current cookie jar |
-> UTCTime | Value that should be used as "now" |
-> Bool | Whether or not this request is coming from an "http" source (not javascript or anything like that) |
-> (ByteString, CookieJar) | (Contents of a "Cookie" header, Updated cookie jar (last-access-time is updated)) |
This corresponds to the algorithm described in Section 5.4 "The Cookie Header"
:: Request | The request to insert into |
-> CookieJar | Current cookie jar |
-> UTCTime | Value that should be used as "now" |
-> (Request, CookieJar) | (Output request, Updated cookie jar (last-access-time is updated)) |
This applies the computeCookieString
to a given Request
:: CookieJar | Input cookie jar |
-> UTCTime | Value that should be used as "now" |
-> CookieJar | Filtered cookie jar |
This corresponds to the eviction algorithm described in Section 5.3 "Storage Model"
destroyCookieJar :: CookieJar -> [Cookie] #
createCookieJar :: [Cookie] -> CookieJar #
pathMatches :: ByteString -> ByteString -> Bool #
This corresponds to the subcomponent algorithm entitled "Path-Match" detailed in section 5.1.4
defaultPath :: Request -> ByteString #
This corresponds to the subcomponent algorithm entitled "Paths" detailed in section 5.1.4
:: ByteString | Domain to test |
-> ByteString | Domain from a cookie |
-> Bool |
This corresponds to the subcomponent algorithm entitled "Domain Matching" detailed in section 5.1.3
isIpAddress :: ByteString -> Bool #
defaultProxy :: ProxyOverride #
The default proxy settings for a manager. In particular: if the http_proxy
(or https_proxy
) environment variable is set, use it. Otherwise, use the values in the Request
.
Since 0.4.7
:: Text | environment variable name |
-> Maybe Proxy | fallback if no environment set |
-> ProxyOverride |
Same as proxyEnvironment
, but instead of default environment variable
names, allows you to set your own name.
Since 0.4.7
:: Maybe Proxy | fallback if no environment set |
-> ProxyOverride |
useProxy :: Proxy -> ProxyOverride #
Use the given proxy settings, regardless of the proxy value in the Request
.
Since 0.4.7
Never connect using a proxy, regardless of the proxy value in the Request
.
Since 0.4.7
proxyFromRequest :: ProxyOverride #
Get the proxy settings from the Request
itself.
Since 0.4.7
withManager :: ManagerSettings -> (Manager -> IO a) -> IO a #
Create, use and close a Manager
.
Since 0.2.1
closeManager :: Manager -> IO () #
Close all connections in a Manager
.
Note that this doesn't affect currently in-flight connections, meaning you can safely use it without hurting any queries you may have concurrently running.
Since 0.1.0
newManager :: ManagerSettings -> IO Manager #
Create a Manager
. The Manager
will be shut down automatically via
garbage collection.
Creating a new Manager
is a relatively expensive operation, you are
advised to share a single Manager
between requests instead.
The first argument to this function is often defaultManagerSettings
,
though add-on libraries may provide a recommended replacement.
Since 0.1.0
defaultManagerSettings :: ManagerSettings #
Default value for ManagerSettings
.
Note that this value does not have support for SSL/TLS. If you need to
make any https connections, please use the http-client-tls package, which
provides a tlsManagerSettings
value.
Since 0.1.0
rawConnectionModifySocketSize :: (Socket -> IO ()) -> IO (Int -> Maybe HostAddress -> String -> Int -> IO Connection) #
Same as rawConnectionModifySocket
, but also takes in a chunk size.
Since: http-client-0.5.2
rawConnectionModifySocket :: (Socket -> IO ()) -> IO (Maybe HostAddress -> String -> Int -> IO Connection) #
A value for the managerRawConnection
setting, but also allows you to
modify the underlying Socket
to set additional settings. For a motivating
use case, see: https://github.com/snoyberg/http-client/issues/71.
Since 0.3.8
observedStreamFile :: (StreamFileStatus -> IO ()) -> FilePath -> IO RequestBody #
Send a file as the request body, while observing streaming progress via
a PopObserver
. Observations are made between reading and sending a chunk.
It is expected that the file size does not change between calling
observedStreamFile
and making any requests using this request body.
Since 0.4.9
streamFile :: FilePath -> IO RequestBody #
Send a file as the request body.
It is expected that the file size does not change between calling
streamFile
and making any requests using this request body.
Since 0.4.9
setQueryStringPartialEscape :: [(ByteString, [EscapeItem])] -> Request -> Request #
Set the query string to the given key/value pairs.
Since: http-client-0.5.10
setQueryString :: [(ByteString, Maybe ByteString)] -> Request -> Request #
Set the query string to the given key/value pairs.
Since 0.3.6
setRequestCheckStatus :: Request -> Request #
Modify the request so that non-2XX status codes generate a runtime
StatusCodeException
, by using throwErrorStatusCodes
Since: http-client-0.5.13
setRequestIgnoreStatus :: Request -> Request #
Modify the request so that non-2XX status codes do not generate a runtime
StatusCodeException
.
Since: http-client-0.4.29
urlEncodedBody :: [(ByteString, ByteString)] -> Request -> Request #
Add url-encoded parameters to the Request
.
This sets a new requestBody
, adds a content-type request header and
changes the method
to POST.
Since 0.1.0
applyBasicProxyAuth :: ByteString -> ByteString -> Request -> Request #
Add a Proxy-Authorization header (with the specified username and
password) to the given Request
. Ignore error handling:
applyBasicProxyAuth "user" "pass" <$> parseRequest "http://example.org"
Since 0.3.4
applyBasicAuth :: ByteString -> ByteString -> Request -> Request #
Add a Basic Auth header (with the specified user name and password) to the given Request. Ignore error handling:
applyBasicAuth "user" "pass" $ parseRequest_ url
NOTE: The function applyDigestAuth
is provided by the http-client-tls
package instead of this package due to extra dependencies. Please use that
package if you need to use digest authentication.
Since 0.1.0
A default request value, a GET request of localhost/:80, with an empty request body.
Note that the default checkResponse
does nothing.
Since: http-client-0.4.30
requestFromURI_ :: URI -> Request #
Same as requestFromURI
, but if the conversion would fail,
throws an impure exception.
Since: http-client-0.5.12
requestFromURI :: MonadThrow m => URI -> m Request #
This can fail if the given URI
is not absolute, or if the
URI
scheme is not "http"
or "https"
. In these cases the function
will throw an error via MonadThrow
.
This function defaults some of the values in Request
, such as setting method
to
GET
and requestHeaders
to []
.
A Request
created by this function won't cause exceptions on non-2XX
response status codes.
Since: http-client-0.5.12
parseRequest_ :: String -> Request #
Same as parseRequest
, but parse errors cause an impure exception.
Mostly useful for static strings which are known to be correctly
formatted.
parseRequest :: MonadThrow m => String -> m Request #
Convert a URL into a Request
.
This function defaults some of the values in Request
, such as setting method
to
GET
and requestHeaders
to []
.
Since this function uses MonadThrow
, the return monad can be anything that is
an instance of MonadThrow
, such as IO
or Maybe
.
You can place the request method at the beginning of the URL separated by a space, e.g.:
@@
parseRequest "POST http://httpbin.org/post"
@@
Note that the request method must be provided as all capital letters.
A Request
created by this function won't cause exceptions on non-2XX
response status codes.
To create a request which throws on non-2XX status codes, see parseUrlThrow
Since: http-client-0.4.30
throwErrorStatusCodes :: MonadIO m => Request -> Response BodyReader -> m () #
Throws a StatusCodeException
wrapped in HttpExceptionRequest
,
if the response's status code indicates an error (if it isn't 2xx).
This can be used to implement checkResponse
.
Since: http-client-0.5.13
parseUrlThrow :: MonadThrow m => String -> m Request #
Same as parseRequest
, except will throw an HttpException
in the
event of a non-2XX response. This uses throwErrorStatusCodes
to
implement checkResponse
.
Since: http-client-0.4.30
parseUrl :: MonadThrow m => String -> m Request #
Deprecated synonym for parseUrlThrow
. You probably want
parseRequest
or parseRequest_
instead.
Since: http-client-0.1.0
brConsume :: BodyReader -> IO [ByteString] #
Strictly consume all remaining chunks of data from the stream.
Since 0.1.0
brReadSome :: BodyReader -> Int -> IO ByteString #
Continuously call brRead
, building up a lazy ByteString until a chunk is
constructed that is at least as many bytes as requested.
Since 0.4.20
brRead :: BodyReader -> IO ByteString #
Get a single chunk of data from the response body, or an empty bytestring if no more data is available.
Note that in order to consume the entire request body, you will need to
repeatedly call this function until you receive an empty ByteString
as a
result.
Since 0.1.0
:: Socket | |
-> Int | chunk size |
-> IO Connection |
Create a new Connection
from a Socket
.
Since: http-client-0.5.3
:: IO ByteString | read |
-> (ByteString -> IO ()) | write |
-> IO () | close |
-> IO Connection |
Create a new Connection
from a read, write, and close function.
Since: http-client-0.5.3
type BodyReader = IO ByteString #
An IO
action that represents an incoming response body coming from the
server. Data provided by this action has already been gunzipped and
de-chunked, and respects any content-length headers present.
The action gets a single chunk of data from the response body, or an empty bytestring if no more data is available.
Since 0.4.0
data HttpException #
An exception which may be generated by this library
Since: http-client-0.5.0
HttpExceptionRequest Request HttpExceptionContent | Most exceptions are specific to a Since: http-client-0.5.0 |
InvalidUrlException String String | A URL (first field) is invalid for a given reason (second argument). Since: http-client-0.5.0 |
Instances
Show HttpException | |
Defined in Network.HTTP.Client.Types showsPrec :: Int -> HttpException -> ShowS # show :: HttpException -> String # showList :: [HttpException] -> ShowS # | |
Exception HttpException | |
Defined in Network.HTTP.Client.Types |
data HttpExceptionContent #
StatusCodeException (Response ()) ByteString | Generated by the May include the beginning of the response body. Since: http-client-0.5.0 |
TooManyRedirects [Response ByteString] | The server responded with too many redirects for a request. Contains the list of encountered responses containing redirects in reverse chronological order; including last redirect, which triggered the exception and was not followed. Since: http-client-0.5.0 |
OverlongHeaders | Either too many headers, or too many total bytes in a single header, were returned by the server, and the memory exhaustion protection in this library has kicked in. Since: http-client-0.5.0 |
ResponseTimeout | The server took too long to return a response. This can
be altered via Since: http-client-0.5.0 |
ConnectionTimeout | Attempting to connect to the server timed out. Since: http-client-0.5.0 |
ConnectionFailure SomeException | An exception occurred when trying to connect to the server. Since: http-client-0.5.0 |
InvalidStatusLine ByteString | The status line returned by the server could not be parsed. Since: http-client-0.5.0 |
InvalidHeader ByteString | The given response header line could not be parsed Since: http-client-0.5.0 |
InternalException SomeException | An exception was raised by an underlying library when performing the request. Most often, this is caused by a failing socket action or a TLS exception. Since: http-client-0.5.0 |
ProxyConnectException ByteString Int Status | A non-200 status code was returned when trying to connect to the proxy server on the given host and port. Since: http-client-0.5.0 |
NoResponseDataReceived | No response data was received from the server at all. This exception may deserve special handling within the library, since it may indicate that a pipelining has been used, and a connection thought to be open was in fact closed. Since: http-client-0.5.0 |
TlsNotSupported | Exception thrown when using a Since: http-client-0.5.0 |
WrongRequestBodyStreamSize Word64 Word64 | The request body provided did not match the expected size. Provides the expected and actual size. Since: http-client-0.4.31 |
ResponseBodyTooShort Word64 Word64 | The returned response body is too short. Provides the expected size and actual size. Since: http-client-0.5.0 |
InvalidChunkHeaders | A chunked response body had invalid headers. Since: http-client-0.5.0 |
IncompleteHeaders | An incomplete set of response headers were returned. Since: http-client-0.5.0 |
InvalidDestinationHost ByteString | The host we tried to connect to is invalid (e.g., an empty string). |
HttpZlibException ZlibException | An exception was thrown when inflating a response body. Since: http-client-0.5.0 |
InvalidProxyEnvironmentVariable Text Text | Values in the proxy environment variable were invalid. Provides the environment variable name and its value. Since: http-client-0.5.0 |
ConnectionClosed | Attempted to use a Since: http-client-0.5.0 |
InvalidProxySettings Text | Proxy settings are not valid (Windows specific currently) @since 0.5.7 |
Instances
Show HttpExceptionContent | |
Defined in Network.HTTP.Client.Types showsPrec :: Int -> HttpExceptionContent -> ShowS # show :: HttpExceptionContent -> String # showList :: [HttpExceptionContent] -> ShowS # |
proxyHost :: Proxy -> ByteString #
The host name of the HTTP proxy.
data RequestBody #
When using one of the RequestBodyStream
/ RequestBodyStreamChunked
constructors, you must ensure that the GivesPopper
can be called multiple
times. Usually this is not a problem.
The RequestBodyStreamChunked
will send a chunked request body. Note that
not all servers support this. Only use RequestBodyStreamChunked
if you
know the server you're sending to supports chunked request bodies.
Since 0.1.0
RequestBodyLBS ByteString | |
RequestBodyBS ByteString | |
RequestBodyBuilder Int64 Builder | |
RequestBodyStream Int64 (GivesPopper ()) | |
RequestBodyStreamChunked (GivesPopper ()) | |
RequestBodyIO (IO RequestBody) | Allows creation of a Since: http-client-0.4.28 |
Instances
IsString RequestBody | Since 0.4.12 |
Defined in Network.HTTP.Client.Types fromString :: String -> RequestBody # | |
Semigroup RequestBody | |
Defined in Network.HTTP.Client.Types (<>) :: RequestBody -> RequestBody -> RequestBody # sconcat :: NonEmpty RequestBody -> RequestBody # stimes :: Integral b => b -> RequestBody -> RequestBody # | |
Monoid RequestBody | |
Defined in Network.HTTP.Client.Types mempty :: RequestBody # mappend :: RequestBody -> RequestBody -> RequestBody # mconcat :: [RequestBody] -> RequestBody # |
type Popper = IO ByteString #
A function which generates successive chunks of a request body, provider a single empty bytestring when no more data is available.
Since 0.1.0
type NeedsPopper a = Popper -> IO a #
A function which must be provided with a Popper
.
Since 0.1.0
type GivesPopper a = NeedsPopper a -> IO a #
A function which will provide a Popper
to a NeedsPopper
. This
seemingly convoluted structure allows for creation of request bodies which
allocate scarce resources in an exception safe manner.
Since 0.1.0
All information on how to connect to a host and what should be sent in the HTTP request.
If you simply wish to download from a URL, see parseRequest
.
The constructor for this data type is not exposed. Instead, you should use
either the defaultRequest
value, or parseRequest
to
construct from a URL, and then use the records below to make modifications.
This approach allows http-client to add configuration options without
breaking backwards compatibility.
For example, to construct a POST request, you could do something like:
initReq <- parseRequest "http://www.example.com/path" let req = initReq { method = "POST" }
For more information, please see http://www.yesodweb.com/book/settings-types.
Since 0.1.0
data ResponseTimeout #
How to deal with timing out a response
Since: http-client-0.5.0
Instances
Eq ResponseTimeout | |
Defined in Network.HTTP.Client.Types (==) :: ResponseTimeout -> ResponseTimeout -> Bool # (/=) :: ResponseTimeout -> ResponseTimeout -> Bool # | |
Show ResponseTimeout | |
Defined in Network.HTTP.Client.Types showsPrec :: Int -> ResponseTimeout -> ShowS # show :: ResponseTimeout -> String # showList :: [ResponseTimeout] -> ShowS # |
A simple representation of the HTTP response.
Since 0.1.0
Instances
Functor Response | |
Foldable Response | |
Defined in Network.HTTP.Client.Types fold :: Monoid m => Response m -> m # foldMap :: Monoid m => (a -> m) -> Response a -> m # foldr :: (a -> b -> b) -> b -> Response a -> b # foldr' :: (a -> b -> b) -> b -> Response a -> b # foldl :: (b -> a -> b) -> b -> Response a -> b # foldl' :: (b -> a -> b) -> b -> Response a -> b # foldr1 :: (a -> a -> a) -> Response a -> a # foldl1 :: (a -> a -> a) -> Response a -> a # elem :: Eq a => a -> Response a -> Bool # maximum :: Ord a => Response a -> a # minimum :: Ord a => Response a -> a # | |
Traversable Response | |
Eq body => Eq (Response body) | |
Show body => Show (Response body) | |
data ManagerSettings #
Settings for a Manager
. Please use the defaultManagerSettings
function and then modify
individual settings. For more information, see http://www.yesodweb.com/book/settings-types.
Since 0.1.0
data ProxyOverride #
How the HTTP proxy server settings should be discovered.
Since 0.4.7
Keeps track of open connections for keep-alive.
If possible, you should share a single Manager
between multiple threads and requests.
Since 0.1.0
Instances
HasHttpManager Manager | |
Defined in Network.HTTP.Client.Types getHttpManager :: Manager -> Manager # |
class HasHttpManager a where #
getHttpManager :: a -> Manager #
Instances
Has ModHttpClient α => HasHttpManager α # | |
Defined in Magicbane.Has getHttpManager :: α -> Manager # | |
HasHttpManager Manager | |
Defined in Network.HTTP.Client.Types getHttpManager :: Manager -> Manager # |
data StreamFileStatus #
Status of streaming a request body from a file.
Since 0.4.9
Instances
Eq StreamFileStatus | |
Defined in Network.HTTP.Client.Types (==) :: StreamFileStatus -> StreamFileStatus -> Bool # (/=) :: StreamFileStatus -> StreamFileStatus -> Bool # | |
Ord StreamFileStatus | |
Defined in Network.HTTP.Client.Types compare :: StreamFileStatus -> StreamFileStatus -> Ordering # (<) :: StreamFileStatus -> StreamFileStatus -> Bool # (<=) :: StreamFileStatus -> StreamFileStatus -> Bool # (>) :: StreamFileStatus -> StreamFileStatus -> Bool # (>=) :: StreamFileStatus -> StreamFileStatus -> Bool # max :: StreamFileStatus -> StreamFileStatus -> StreamFileStatus # min :: StreamFileStatus -> StreamFileStatus -> StreamFileStatus # | |
Show StreamFileStatus | |
Defined in Network.HTTP.Client.Types showsPrec :: Int -> StreamFileStatus -> ShowS # show :: StreamFileStatus -> String # showList :: [StreamFileStatus] -> ShowS # |
unreserved :: Char -> Bool #
parseabsoluteURI :: String -> Maybe URI #
normalizePathSegments :: String -> String #
Path segment normalization; cf. RFC3986 section 6.2.2.3
normalizeEscape :: String -> String #
Encoding normalization; cf. RFC3986 section 6.2.2.2
normalizeCase :: String -> String #
Case normalization; cf. RFC3986 section 6.2.2.1 NOTE: authority case normalization is not performed
relativeFrom :: URI -> URI -> URI #
Returns a new URI
which represents the relative location of
the first URI
with respect to the second URI
. Thus, the
values supplied are expected to be absolute URIs, and the result
returned may be a relative URI.
Example:
"http://example.com/Root/sub1/name2#frag" `relativeFrom` "http://example.com/Root/sub2/name2#frag" == "../sub1/name2#frag"
There is no single correct implementation of this function, but any acceptable implementation must satisfy the following:
(uabs `relativeFrom` ubase) `relativeTo` ubase == uabs
For any valid absolute URI. (cf. http://lists.w3.org/Archives/Public/uri/2003Jan/0008.html http://lists.w3.org/Archives/Public/uri/2003Jan/0005.html)
pathSegments :: URI -> [String] #
Returns the segments of the path component. E.g., pathSegments $ parseURI "http://example.org/foo/bar/baz" == ["foo", "bar", "baz"]
relativeTo :: URI -> URI -> URI #
nonStrictRelativeTo :: URI -> URI -> URI #
unEscapeString :: String -> String #
Turns all instances of escaped characters in the string back into literal characters.
:: (Char -> Bool) | a predicate which returns |
-> String | the string to process |
-> String | the resulting URI string |
Can be used to make a string valid for use in a URI.
escapeURIChar :: (Char -> Bool) -> Char -> String #
Escape character if supplied predicate is not satisfied, otherwise return character as singleton string.
isUnescapedInURIComponent :: Char -> Bool #
Returns True
if the character is allowed unescaped in a URI component.
>>>
escapeURIString isUnescapedInURIComponent "http://haskell.org:80?some_param=true&other_param=їґ"
"http%3A%2F%2Fhaskell.org%3A80%3Fsome_param%3Dtrue%26other_param%3D%D1%97%D2%91"
isUnescapedInURI :: Char -> Bool #
Returns True
if the character is allowed unescaped in a URI.
>>>
escapeURIString isUnescapedInURI "http://haskell.org:80?some_param=true&other_param=їґ"
"http://haskell.org:80?some_param=true&other_param=%D1%97%D2%91"
isAllowedInURI :: Char -> Bool #
Returns True
if the character is allowed in a URI.
uriToString :: (String -> String) -> URI -> ShowS #
Turn a URI
into a string.
Uses a supplied function to map the userinfo part of the URI.
The Show instance for URI uses a mapping that hides any password
that may be present in the URI. Use this function with argument id
to preserve the password in the formatted output.
isUnreserved :: Char -> Bool #
Returns True
if the character is an "unreserved" character in
a URI. These characters do not need to be escaped in a URI. The
only characters allowed in a URI are either "reserved",
"unreserved", or an escape sequence (%
followed by two hex digits).
isReserved :: Char -> Bool #
Returns True
if the character is a "reserved" character in a
URI. To include a literal instance of one of these characters in a
component of a URI, it must be escaped.
uriIsRelative :: URI -> Bool #
uriIsAbsolute :: URI -> Bool #
isIPv4address :: String -> Bool #
Test if string contains a valid IPv4 address
isIPv6address :: String -> Bool #
Test if string contains a valid IPv6 address
isAbsoluteURI :: String -> Bool #
Test if string contains a valid absolute URI (an absolute URI without a fragment identifier).
isRelativeReference :: String -> Bool #
Test if string contains a valid relative URI (a relative URI with optional fragment identifier).
isURIReference :: String -> Bool #
Test if string contains a valid URI reference (an absolute or relative URI with optional fragment identifier).
Test if string contains a valid URI (an absolute URI with optional fragment identifier).
parseAbsoluteURI :: String -> Maybe URI #
parseRelativeReference :: String -> Maybe URI #
parseURIReference :: String -> Maybe URI #
parseURI :: String -> Maybe URI #
Turn a string containing a URI into a URI
.
Returns Nothing
if the string is not a valid URI;
(an absolute URI with optional fragment identifier).
NOTE: this is different from the previous network.URI,
whose parseURI
function works like parseURIReference
in this module.
Type for authority value within a URI
URIAuth | |
|
Instances
Eq URIAuth | |
Data URIAuth | |
Defined in Network.URI gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URIAuth -> c URIAuth # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URIAuth # toConstr :: URIAuth -> Constr # dataTypeOf :: URIAuth -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URIAuth) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URIAuth) # gmapT :: (forall b. Data b => b -> b) -> URIAuth -> URIAuth # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URIAuth -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URIAuth -> r # gmapQ :: (forall d. Data d => d -> u) -> URIAuth -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> URIAuth -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> URIAuth -> m URIAuth # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URIAuth -> m URIAuth # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URIAuth -> m URIAuth # | |
Ord URIAuth | |
Show URIAuth | |
NFData URIAuth | |
Defined in Network.URI |