Packages

trait TimeoutAccess extends AnyRef

Enables programmatic access to the server-side request timeout logic.

Not for user extension.

Annotations
@DoNotInherit()
Source
TimeoutAccess.java
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeoutAccess
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def getTimeout(): Duration

    Returns the currently set timeout.

    Returns the currently set timeout. The timeout period is measured as of the point in time that the end of the request has been received, which may be in the past or in the future!

    Due to the inherent raciness it is not guaranteed that the returned timeout was applied before the previously set timeout has expired!

  2. abstract def update(timeout: Duration, handler: Function[HttpRequest, HttpResponse]): Unit

    Tries to set a new timeout and handler at the same time.

    Tries to set a new timeout and handler 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!

  3. abstract def updateHandler(handler: Function[HttpRequest, HttpResponse]): Unit

    Tries to set a new timeout handler, which produces the timeout response for a given request.

    Tries to set a new 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!

  4. abstract def updateTimeout(timeout: Duration): Unit

    Tries to set a new timeout.

    Tries to set a new timeout. The timeout period is measured as of the point in time that the end of the request has been received, which may be in the past or in the future! Use Duration.Inf to completely disable request timeout checking for this request.

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