open-consul/vendor/github.com/hashicorp/go-retryablehttp
James Phillips 4515a1d90b
Updates hashicorp/go-retryablehttp.
2016-08-09 17:24:39 -07:00
..
LICENSE Updates armon/go-metrics and adds Circonus vendored libraries. 2016-07-19 16:54:21 -07:00
Makefile Updates armon/go-metrics and adds Circonus vendored libraries. 2016-07-19 16:54:21 -07:00
README.md Updates armon/go-metrics and adds Circonus vendored libraries. 2016-07-19 16:54:21 -07:00
client.go Updates armon/go-metrics and adds Circonus vendored libraries. 2016-07-19 16:54:21 -07:00

README.md

go-retryablehttp

Build Status Go Documentation

The retryablehttp package provides a familiar HTTP client interface with automatic retries and exponential backoff. It is a thin wrapper over the standard net/http client library and exposes nearly the same public API. This makes retryablehttp very easy to drop into existing programs.

retryablehttp performs automatic retries under certain conditions. Mainly, if an error is returned by the client (connection errors, etc.), or if a 500-range response code is received, then a retry is invoked after a wait period. Otherwise, the response is returned and left to the caller to interpret.

The main difference from net/http is that requests which take a request body (POST/PUT et. al) require an io.ReadSeeker to be provided. This enables the request body to be "rewound" if the initial request fails so that the full request can be attempted again.

Example Use

Using this library should look almost identical to what you would do with net/http. The most simple example of a GET request is shown below:

resp, err := retryablehttp.Get("/foo")
if err != nil {
    panic(err)
}

The returned response object is an *http.Response, the same thing you would usually get from net/http. Had the request failed one or more times, the above call would block and retry with exponential backoff.

For more usage and examples see the godoc.