Apache Pekko HTTP
1.1.0
API
Generated with
Apache Pekko HTTP/org.apache.pekko.http/org.apache.pekko.http.scaladsl/org.apache.pekko.http.scaladsl.server/org.apache.pekko.http.scaladsl.server.directives/TimeoutDirectives

TimeoutDirectives

org.apache.pekko.http.scaladsl.server.directives.TimeoutDirectives
See theTimeoutDirectives companion object
trait TimeoutDirectives

Attributes

Companion
object
Source
TimeoutDirectives.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Directives
object Directives
class HttpApp

Members list

Grouped members

Timeout directives

def extractRequestTimeout: Directive1[Duration]

Return the currently set request timeout.

Return the currently set request timeout.

Note that this may be changed in inner directives.

Attributes

Source
TimeoutDirectives.scala
def withRequestTimeout(timeout: Duration): Directive0

Tries to set a new request timeout and handler (if provided) at the same time.

Tries to set a new request timeout and handler (if provided) at the same time.

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Attributes

Source
TimeoutDirectives.scala
def withRequestTimeout(timeout: Duration, handler: HttpRequest => HttpResponse): Directive0

Tries to set a new request timeout and handler (if provided) at the same time.

Tries to set a new request timeout and handler (if provided) at the same time.

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Value parameters

handler

optional custom "timeout response" function. If left None, the default timeout HttpResponse will be used.

Attributes

Source
TimeoutDirectives.scala
def withRequestTimeout(timeout: Duration, handler: Option[HttpRequest => HttpResponse]): Directive0

Tries to set a new request timeout and handler (if provided) at the same time.

Tries to set a new request timeout and handler (if provided) at the same time.

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Value parameters

handler

optional custom "timeout response" function. If left None, the default timeout HttpResponse will be used.

Attributes

Source
TimeoutDirectives.scala
def withRequestTimeoutResponse(handler: HttpRequest => HttpResponse): Directive0

Tries to set a new request timeout handler, which produces the timeout response for a given request. Note that the handler must produce the response synchronously and shouldn't block!

Tries to set a new request timeout handler, which produces the timeout response for a given request. Note that the handler must produce the response synchronously and shouldn't block!

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Attributes

Source
TimeoutDirectives.scala
Generated with