Conduit powered version of withResponse. Differences are:

• Response body is represented as a Producer.
• Generalized to any instance of MonadUnliftIO, not just IO.
• The Manager is contained by a MonadReader context.

Since 2.1.0

Conduit-powered version of responseOpen.

See withResponse for the differences with responseOpen.

Since 2.1.0

Generalized version of responseClose.

Since 2.1.0

An Acquire for getting a Response.

Since 2.1.0

Same as httpSource, but uses Manager from Reader environment instead of the global one.

Since 2.3.6

TLS-powered manager settings.

Since 2.1.0

Get a new manager using defaultManagerSettings.

Since 2.1.0

Get a new manager using the given settings.

Since 2.1.0

Define a HTTP proxy, consisting of a hostname and port number.

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

Status of streaming a request body from a file.

Since 0.4.9

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

How the HTTP proxy server settings should be discovered.

Since 0.4.7

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

A simple representation of the HTTP response.

Since 0.1.0

How to deal with timing out on retrieval of response headers.

Since: http-client-0.5.0

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

A function which must be provided with a Popper.

Since 0.1.0

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

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

An exception which may be generated by this library

Since: http-client-0.5.0

Instead of (==).

Since there was some confusion in the history of this library about how the Eq instance should work, it was removed for clarity, and replaced by equal and equiv. equal gives you equality of all fields of the Cookie record.

Since: http-client-0.7.0

Equality of name, domain, path only. This corresponds to step 11 of the algorithm described in Section 5.3 "Storage Model". See also: equal.

Since: http-client-0.7.0

Instead of instance Ord Cookie. See equalCookie, equivCookie.

Since: http-client-0.7.0

See equalCookie.

Since: http-client-0.7.0

See equalCookieJar, equalCookie.

Since: http-client-0.7.0

Create a new Connection from a read, write, and close function.

Since: http-client-0.5.3

Create a new Connection from a Socket.

Since: http-client-0.5.3

strippedHostName takes a URI host name, as extracted by regName, and strips square brackets around IPv6 addresses.

The result is suitable for passing to services such as name resolution (getAddr).

@since

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

Deprecated synonym for parseUrlThrow. You probably want parseRequest or parseRequest_ instead.

Since: http-client-0.1.0

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

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

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

Same as parseRequest, but parse errors cause an impure exception. Mostly useful for static strings which are known to be correctly formatted.

Convert a URI into a 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

Same as requestFromURI, but if the conversion would fail, throws an impure exception.

Since: http-client-0.5.12

Extract a URI from the request.

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

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

Add a Bearer Auth header to the given Request

Since: http-client-0.7.6

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

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

Modify the request so that non-2XX status codes do not generate a runtime StatusCodeException.

Since: http-client-0.4.29

Modify the request so that non-2XX status codes generate a runtime StatusCodeException, by using throwErrorStatusCodes

Since: http-client-0.5.13

Set the query string to the given key/value pairs.

Since 0.3.6

Set the query string to the given key/value pairs.

Since: http-client-0.5.10

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

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

Retrieve the orignal Request from a Response

Note that the requestBody is not available and always set to empty.

Since: http-client-0.7.8

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

Same as rawConnectionModifySocket, but also takes in a chunk size.

Since: http-client-0.5.2

Create, use and close a Manager.

Since 0.2.1

Get the proxy settings from the Request itself.

Since 0.4.7

Never connect using a proxy, regardless of the proxy value in the Request.

Since 0.4.7

Use the given proxy settings, regardless of the proxy value in the Request.

Since 0.4.7

Send secure requests to the proxy in plain text rather than using CONNECT, regardless of the value in the Request.

Since: http-client-0.7.2

Get the proxy settings from the default environment variable (http_proxy for insecure, https_proxy for secure). If no variable is set, then fall back to the given value. Nothing is equivalent to noProxy, Just is equivalent to useProxy.

Since 0.4.7

Same as proxyEnvironment, but instead of default environment variable names, allows you to set your own name.

Since 0.4.7

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

This corresponds to the subcomponent algorithm entitled "Domain Matching" detailed in section 5.1.3

This corresponds to the subcomponent algorithm entitled "Paths" detailed in section 5.1.4

This corresponds to the subcomponent algorithm entitled "Path-Match" detailed in section 5.1.4

Algorithm described in "Secure Contexts", Section 3.1, "Is origin potentially trustworthy?"

Note per RFC6265 section 5.4 user agent is free to define the meaning of "secure" protocol.

See: https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy

This corresponds to the eviction algorithm described in Section 5.3 "Storage Model"

This applies the computeCookieString to a given Request

This corresponds to the algorithm described in Section 5.4 "The Cookie Header"

This applies receiveSetCookie to a given Response

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.

Insert a cookie created by generateCookie into the cookie jar (or not if it shouldn't be allowed in)

Turn a SetCookie into a Cookie, if it is valid

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

A datatype holding information on redirected requests and the final response.

Since 0.4.1

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

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

Set the proxy override value, only for HTTP (insecure) connections.

Since 0.4.7

Set the proxy override value, only for HTTPS (secure) connections.

Since 0.4.7

Set the proxy override value, for both HTTP (insecure) and HTTPS (insecure) connections.

Since 0.4.7

Specify maximum time in microseconds the retrieval of response headers is allowed to take

Since: http-client-0.5.0

Do not have a response timeout

Since: http-client-0.5.0

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

Same as httpLbs, except it uses the Manager in the reader environment.

Since 2.1.1

Same as httpNoBody, except it uses the Manager in the reader environment.

This can be more convenient that using withManager as it avoids the need to specify the base monad for the response body.

Since 2.1.2