object Timeout

Source
Timeout.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Timeout
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply[F[_], G[_], A](timeout: FiniteDuration)(http: Kleisli[F, A, Response[G]])(implicit F: Temporal[F]): Kleisli[F, A, Response[G]]

    Transform the service to return a timeout response after the given duration if the service has not yet responded.

    Transform the service to return a timeout response after the given duration if the service has not yet responded. If the timeout fires, the service's response is canceled.

    timeout

    Finite duration to wait before returning a 503 Service Unavailable response

    Note

    if the service runs uncancelable effects while responding (e.g. if service uses MonadCancel#uncancelable under the hood) and has exceeded the timeout, then the expected behavior is:

    • uncancelable effects will be completed naturally (regardless of how long it takes),
    • after that, the timeout response will be returned. To get more insights on effect cancelation, dig into the MonadCancel documentation.
  5. def apply[F[_], G[_], A](timeout: FiniteDuration, timeoutResponse: F[Response[G]])(http: Kleisli[F, A, Response[G]])(implicit F: Temporal[F]): Kleisli[F, A, Response[G]]

    Transform the service to return a timeout response after the given duration if the service has not yet responded.

    Transform the service to return a timeout response after the given duration if the service has not yet responded. If the timeout fires, the service's response is canceled.

    timeout

    Finite duration to wait before returning the provided response

    Note

    if the service runs uncancelable effects while responding (e.g. if service uses MonadCancel#uncancelable under the hood) and has exceeded the timeout, then the expected behavior is:

    • uncancelable effects will be completed naturally (regardless of how long it takes),
    • after that, the timeout response will be returned. To get more insights on effect cancelation, dig into the MonadCancel documentation.
  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]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def httpApp[F[_]](timeout: FiniteDuration, timeoutResponse: F[Response[F]])(httpApp: HttpApp[F])(implicit F: Temporal[F]): HttpApp[F]

    This is the same as apply[F[_],G[_],A](timeout:scala\.concurrent\.duration\.FiniteDuration,timeoutResponse*, but for HttpApp

  14. def httpApp[F[_]](timeout: FiniteDuration)(httpApp: HttpApp[F])(implicit F: Temporal[F]): HttpApp[F]

    This is the same as apply[F[_],G[_],A](timeout:scala\.concurrent\.duration\.FiniteDuration)*, but for HttpApp

  15. def httpRoutes[F[_]](timeout: FiniteDuration, timeoutResponse: F[Response[F]])(httpRoutes: HttpRoutes[F])(implicit F: Temporal[F]): HttpRoutes[F]

    This is the same as apply[F[_],G[_],A](timeout:scala\.concurrent\.duration\.FiniteDuration,timeoutResponse*, but for HttpRoutes

  16. def httpRoutes[F[_]](timeout: FiniteDuration)(httpRoutes: HttpRoutes[F])(implicit F: Temporal[F]): HttpRoutes[F]

    This is the same as apply[F[_],G[_],A](timeout:scala\.concurrent\.duration\.FiniteDuration)*, but for HttpRoutes

  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
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped