withRequestTimeoutResponse

Description

Allows customising the HttpResponse that will be sent to clients in case of a Request timeout.

See also withRequestTimeout or withoutRequestTimeout if interested in dynamically changing the timeout for a given route instead.

Warning

Please note that setting handler is inherently racy as the timeout is measured from starting to handle the request to its deadline, thus if the timeout triggers before the withRequestTimeoutResponse executed it would have emitted the default timeout HttpResponse.

In practice this can only be a problem with very tight timeouts, so with default settings of request timeouts being measured in seconds it shouldn’t be a problem in reality (though certainly a possibility still).

To learn more about various timeouts in Akka HTTP and how to configure them see Akka HTTP Timeouts.

Example

final Duration timeout = Duration.create(100, TimeUnit.MILLISECONDS);
CompletionStage<String> slowFuture = new CompletableFuture<>();

HttpResponse enhanceYourCalmResponse = HttpResponse.create()
        .withStatus(StatusCodes.ENHANCE_YOUR_CALM)
        .withEntity("Unable to serve response within time limit, please enhance your calm.");

final Route route = path("timeout", () ->
        withRequestTimeout(timeout, () ->
                // racy! for a very short timeout like 1.milli you can still get 503
                withRequestTimeoutResponse((request) -> enhanceYourCalmResponse, () -> {
                    return completeOKWithFutureString(slowFuture); // very slow
                }))
);

// test:
StatusCode statusCode = runRoute(system, materializer, route, "timeout").get().status();
assert (StatusCodes.ENHANCE_YOUR_CALM.equals(statusCode));