Documentation

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

Since: http-client-0.5.13

Set the request method

Since: http-conduit-2.1.10

Set the given request header to the given list of values. Removes any previously set header values with the same name.

Since: http-conduit-2.1.10

Set the request headers, wiping out all previously set headers. This means if you use setRequestHeaders to set some headers and also use one of the other setters that modifies the content-type header (such as setRequestBodyJSON), be sure that setRequestHeaders is evaluated first.

Since: http-conduit-2.1.10

Add a request header name/value combination

Since: http-conduit-2.1.10

Set the request body to the given RequestBody. You may want to consider using one of the convenience functions in the modules, e.g. requestBodyJSON.

Note: This will not modify the request method. For that, please use requestMethod. You likely don't want the default of GET.

Since: http-conduit-2.1.10

Get all response headers

Since: http-conduit-2.1.10

Get the response body

Since: http-conduit-2.1.10

Get the integral status code of the response

Since: http-conduit-2.1.10

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

Extract a URI from the request.

Since 0.1.0

Everything from the host to the query string.

Since 0.1.0

Check the response immediately after receiving the status and headers. This can be useful for throwing exceptions on non-success status codes.

In previous versions of http-client, this went under the name checkStatus, but was renamed to avoid confusion about the new default behavior (doing nothing).

Since: http-client-0.5.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

Custom HTTP request headers

The Content-Length and Transfer-Encoding headers are set automatically by this module, and shall not be added to requestHeaders.

If not provided by the user, Host will automatically be set based on the host and port fields.

Moreover, the Accept-Encoding header is set implicitly to gzip for convenience by default. This behaviour can be overridden if needed, by setting the header explicitly to a different value. In order to omit the Accept-Header altogether, set it to the empty string "". If you need an empty Accept-Header (i.e. requesting the identity encoding), set it to a non-empty white-space string, e.g. " ". See RFC 2616 section 14.3 for details about the semantics of the Accept-Header field. If you request a content-encoding not supported by this module, you will have to decode it yourself (see also the decompress field).

Note: Multiple header fields with the same field-name will result in multiple header fields being sent and therefore it's the responsibility of the client code to ensure that the rules from RFC 2616 section 4.2 are honoured.

Since 0.1.0

Get the current global Manager

Since: http-client-tls-0.2.4

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: http-client-tls-0.3.1

User friendly display of a DigestAuthException

Since: http-client-tls-0.3.3

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

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

A simple representation of the HTTP response.

Since 0.1.0

An exception which may be generated by this library

Since: http-client-0.5.0

Not Found 404

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

HTTP Header names according to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

HTTP request method, eg GET, POST.

Since 0.1.0

HTTP Method constants.

HTTP Method constants.

Add form data to the Request.

This sets a new requestBody, adds a content-type request header and changes the method to POST.

Construct a Part from form name, filepath and a RequestBody

partFileRequestBody "who_calls" "caller.json" $ RequestBodyBS "{\"caller\":\"Jason J Jason\"}"

-- empty upload form
partFileRequestBody "file" mempty mempty

The Part does not have a content type associated with it.

Make a Part whose content is a strict ByteString.

The Part does not have a file name or content type associated with it.

Make a Part whose content is a lazy ByteString.

The Part does not have a file name or content type associated with it.

Set the user-agent request header

Download the given URL to the given location. If the file already exists, no download is performed. Otherwise, creates the parent directory, downloads to a temporary file, and on file download completion moves to the appropriate destination.

Throws an exception if things go wrong

Same as download, but will download a file a second time if it is already present.

Returns True if the file was downloaded, False otherwise

Copied and extended version of Network.HTTP.Download.download.

Has the following additional features: * Verifies that response content-length header (if present) matches expected length * Limits the download to (close to) the expected # of bytes * Verifies that the expected # bytes were downloaded (not too few) * Verifies md5 if response includes content-md5 header * Verifies the expected hashes

Throws VerifiedDownloadException. Throws IOExceptions related to file system operations. Throws HttpException.

A request together with some checks to perform.

Construct using the downloadRequest smart constructor and associated setters. The constructor itself is not exposed to avoid breaking changes with additional fields.

Since: http-download-0.2.0.0

Default to retrying seven times with exponential backoff starting from one hundred milliseconds.

This means the tries will occur after these delays if necessary:

• 0.1s
• 0.2s
• 0.4s
• 0.8s
• 1.6s
• 3.2s
• 6.4s

An exception regarding verification of a download.

Construct a new DownloadRequest from the given Request. Use associated setters to modify the value further.

Since: http-download-0.2.0.0

Set the hash checks to be run when verifying.

Since: http-download-0.2.0.0

Set the length check to be run when verifying.

Since: http-download-0.2.0.0

Set the retry policy to be used when downloading.

Since: http-download-0.2.0.0

If True, force download even if the file already exists. Useful for download a resource which may change over time.