Packages

trait TimeoutAccess extends javadsl.TimeoutAccess

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

Not for user extension.

Annotations
@DoNotInherit()
Source
TimeoutAccess.scala
Linear Supertypes
javadsl.TimeoutAccess, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeoutAccess
  2. TimeoutAccess
  3. AnyRef
  4. 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 timeout: 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: (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 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!

    Definition Classes
    TimeoutAccess
    Since

    1.3.0

  4. 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!

    Definition Classes
    TimeoutAccess
  5. abstract def updateHandler(handler: (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!

  6. 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!

    Definition Classes
    TimeoutAccess
  7. 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!

    Definition Classes
    TimeoutAccess → TimeoutAccess
  8. 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 a java.time.Duration with a long duration to disable request timeout checking for this request (e.g. java.time.temporal.ChronoUnit.FOREVER.getDuration()).

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

    Definition Classes
    TimeoutAccess
    Since

    1.3.0

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toany2stringadd[TimeoutAccess] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TimeoutAccess, B)
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toArrowAssoc[TimeoutAccess] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def ensuring(cond: (TimeoutAccess) => Boolean, msg: => Any): TimeoutAccess
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toEnsuring[TimeoutAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TimeoutAccess) => Boolean): TimeoutAccess
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toEnsuring[TimeoutAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TimeoutAccess
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toEnsuring[TimeoutAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TimeoutAccess
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toEnsuring[TimeoutAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. 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!

    In 2.0.0, the return type of this method changed from scala.concurrent.duration.Duration to java.time.Duration.

    Definition Classes
    TimeoutAccess → TimeoutAccess
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toStringFormat[TimeoutAccess] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (TimeoutAccess, B)
    Implicit
    This member is added by an implicit conversion from TimeoutAccess toArrowAssoc[TimeoutAccess] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from javadsl.TimeoutAccess

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTimeoutAccess to any2stringadd[TimeoutAccess]

Inherited by implicit conversion StringFormat fromTimeoutAccess to StringFormat[TimeoutAccess]

Inherited by implicit conversion Ensuring fromTimeoutAccess to Ensuring[TimeoutAccess]

Inherited by implicit conversion ArrowAssoc fromTimeoutAccess to ArrowAssoc[TimeoutAccess]

Ungrouped