Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to handle response timeout?

In akka-http routing I can return Future as a response that implicitly converts to ToResponseMarshaller.

Is there some way to handle timeout of this future? Or timeout of connection in route level? Or one way is to use Await() function?

Right now client can wait response forever.

complete {
   val future = for {
     response <- someIOFunc()
     entity <- someOtherFunc()
   } yield entity
   future.onComplete({
     case Success(result) =>
       HttpResponse(entity = HttpEntity(MediaTypes.`text/xml`, result))
     case Failure(result) =>
       HttpResponse(entity = utils.getFault("fault"))
   })
   future
 }
like image 500
diemust Avatar asked Mar 28 '15 14:03

diemust


People also ask

How do you handle request timeout?

Timeouts can be easily added to the URL you are requesting. It so happens that, you are using a third-party URL and waiting for a response. It is always a good practice to give a timeout on the URL, as we might want the URL to respond within a timespan with a response or an error.

Why should you handle response timeout while calling any API?

Request timeouts are useful for preventing a poor user experience, especially if there's an alternative that we can default to when a resource is taking too long.

What is a response timeout?

A response timeout occurs after the request has been forwarded to the CICS® server. It can happen to a synchronous call, an asynchronous call, or to the reply solicitation call that retrieves the reply from an asynchronous call.


1 Answers

Adding a timeout to an asynchronous operation means creating a new Future that is completed either by the operation itself or by the timeout:

import akka.pattern.after
val future = ...
val futureWithTimeout = Future.firstCompletedOf(
    future ::
    after(1.second, system.scheduler)(Future.failed(new TimeoutException)) ::
    Nil
  )

The second Future could also hold a successful result that replaces the error, depending on what exactly it is that you want to model.

As a side note: the presented code sample contains dead code, registering an onComplete handler on a Future only makes sense for side-effects but you seem to want to transform the Future’s value and create an HttpEntity from it. That should be done using map and recover:

future
  .map(result => HttpResponse(entity = HttpEntity(MediaTypes.`text/xml`, result)))
  .recover { case ex => HttpResponse(entity = utils.getFault("fault")) }

This would then be the overall return value that is passed to the complete directive.

like image 195
Roland Kuhn Avatar answered Nov 15 '22 06:11

Roland Kuhn