Network.HTTP.Client.Manager

Documentation

data Manager

Keeps track of open connections for keep-alive. If possible, you should share a single Manager between multiple threads and requests.

mResponseTimeout :: Manager -> Maybe Int

Copied from managerResponseTimeout

mRetryableException :: Manager -> SomeException -> Bool

mWrapIOException :: Manager -> forall a. IO a -> IO a

data ManagerSettings

Settings for a Manager. Please use the defaultManagerSettings function and then modify individual settings.

Constructors

ManagerSettings

Fields

managerConnCount :: !Int

Number of connections to a single host to keep alive. Default: 10.

managerRawConnection :: !(IO (Maybe HostAddress -> String -> Int -> IO Connection))

Create an insecure connection.

managerTlsConnection :: !(IO (Maybe HostAddress -> String -> Int -> IO Connection))

Create a TLS connection. Default behavior: throw an exception that TLS is not supported.

managerResponseTimeout :: !(Maybe Int)

Default timeout (in microseconds) to be applied to requests which do not provide a timeout value.

Default is 5 seconds

Since 1.9.3

managerRetryableException :: !(SomeException -> Bool)

Exceptions for which we should retry our request if we were reusing an already open connection. In the case of IOExceptions, for example, we assume that the connection was closed on the server and therefore open a new one.

managerWrapIOException :: !(forall a. IO a -> IO a)

data ConnKey

ConnKey consists of a hostname, a port and a Bool specifying whether to use SSL.

Constructors

ConnKey !ConnHost !Int !Bool

Instances

Eq ConnKey

Ord ConnKey

Show ConnKey

data ConnHost

Hostname or resolved host address.

Constructors

HostName !Text

HostAddress !HostAddress

Instances

Eq ConnHost

Ord ConnHost

Show ConnHost

newManager :: ManagerSettings -> IO Manager

Create a Manager. You must manually call closeManager to shut it down.

Creating a new Manager is an expensive operation, you are advised to share a single Manager between requests instead.

closeManager :: Manager -> IO ()

Close all connections in a Manager. Afterwards, the Manager can be reused if desired.

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.

getConn :: Request -> Manager -> IO (ConnRelease, Connection, ManagedConn)

data ConnReuse

Constructors

Reuse

DontReuse

type ConnRelease = ConnReuse -> IO ()

data ManagedConn

Constructors

Fresh

Reused

failedConnectionException :: Request -> HttpException

Create an exception to be thrown if the connection for the given request fails.

defaultManagerSettings :: ManagerSettings