| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Network.HTTP.Client.TLS
Description
Support for making connections via the connection package and, in turn, the tls package suite.
Recommended reading: https://haskell-lang.org/library/http-client
Synopsis
- tlsManagerSettings :: ManagerSettings
- mkManagerSettings :: TLSSettings -> Maybe SockSettings -> ManagerSettings
- mkManagerSettingsContext :: Maybe ConnectionContext -> TLSSettings -> Maybe SockSettings -> ManagerSettings
- newTlsManager :: MonadIO m => m Manager
- newTlsManagerWith :: MonadIO m => ManagerSettings -> m Manager
- applyDigestAuth :: (MonadIO m, MonadThrow n) => ByteString -> ByteString -> Request -> Manager -> m (n Request)
- data DigestAuthException = DigestAuthException Request (Response ()) DigestAuthExceptionDetails
- data DigestAuthExceptionDetails
- displayDigestAuthException :: DigestAuthException -> String
- getGlobalManager :: IO Manager
- setGlobalManager :: Manager -> IO ()
Settings
tlsManagerSettings :: ManagerSettings Source #
Default TLS-enabled manager settings
mkManagerSettings :: TLSSettings -> Maybe SockSettings -> ManagerSettings Source #
Create a TLS-enabled ManagerSettings with the given TLSSettings and
SockSettings
mkManagerSettingsContext :: Maybe ConnectionContext -> TLSSettings -> Maybe SockSettings -> ManagerSettings Source #
Same as mkManagerSettings, but also takes an optional
ConnectionContext. Providing this externally can be an
optimization, though that may change in the future. For more
information, see:
https://github.com/snoyberg/http-client/pull/227
Since: 0.3.2
newTlsManager :: MonadIO m => m Manager Source #
Load up a new TLS manager with default settings, respecting proxy environment variables.
Since: 0.3.4
newTlsManagerWith :: MonadIO m => ManagerSettings -> m Manager Source #
Load up a new TLS manager based upon specified settings, respecting proxy environment variables.
Since: 0.3.5
Digest authentication
Arguments
| :: (MonadIO m, MonadThrow n) | |
| => ByteString | username |
| -> ByteString | password |
| -> Request | |
| -> Manager | |
| -> m (n Request) |
Apply digest authentication to this request.
Note that this function will need to make an HTTP request to the
server in order to get the nonce, thus the need for a Manager and
to live in IO. This also means that the request body will be sent
to the server. If the request body in the supplied Request can
only be read once, you should replace it with a dummy value.
In the event of successfully generating a digest, this will return
a Just value. If there is any problem with generating the digest,
it will return Nothing.
Since: 0.3.1
data DigestAuthException Source #
Generated by applyDigestAuth when it is unable to apply the
digest credentials to the request.
Since: 0.3.3
Constructors
| DigestAuthException Request (Response ()) DigestAuthExceptionDetails |
Instances
| Exception DigestAuthException Source # | |
Defined in Network.HTTP.Client.TLS Methods toException :: DigestAuthException -> SomeException # fromException :: SomeException -> Maybe DigestAuthException # | |
| Show DigestAuthException Source # | |
Defined in Network.HTTP.Client.TLS Methods showsPrec :: Int -> DigestAuthException -> ShowS # show :: DigestAuthException -> String # showList :: [DigestAuthException] -> ShowS # | |
data DigestAuthExceptionDetails Source #
Detailed explanation for failure for DigestAuthException
Since: 0.3.3
Constructors
| UnexpectedStatusCode | |
| MissingWWWAuthenticateHeader | |
| WWWAuthenticateIsNotDigest | |
| MissingRealm | |
| MissingNonce |
Instances
displayDigestAuthException :: DigestAuthException -> String Source #
User friendly display of a DigestAuthException
Since: 0.3.3