Object/Trait

org.scalatest.concurrent

Timeouts

Related Docs: trait Timeouts | package concurrent

Permalink

object Timeouts extends Timeouts

Companion object that facilitates the importing of Timeouts members as an alternative to mixing in the trait. One use case is to import Timeouts's members so you can use them in the Scala interpreter.

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def cancelAfter[T](timeout: Span)(f: ⇒ T)(implicit interruptor: Interruptor, pos: Position = implicitly[source.Position]): T

    Permalink

    Executes the passed function, enforcing the passed time limit by attempting to interrupt the function if the time limit is exceeded, and throwing TestCanceledException if the time limit has been exceeded after the function completes.

    Executes the passed function, enforcing the passed time limit by attempting to interrupt the function if the time limit is exceeded, and throwing TestCanceledException if the time limit has been exceeded after the function completes.

    If the function completes before the timeout expires:

    • If the function returns normally, this method will return normally.
    • If the function completes abruptly with an exception, this method will complete abruptly with that same exception.

    If the function completes after the timeout expires:

    • If the function returns normally, this method will complete abruptly with a TestCanceledException.
    • If the function completes abruptly with an exception, this method will complete abruptly with a TestCanceledException that includes the exception thrown by the function as its cause.

    If the interrupted status of the main test thread (the thread that invoked cancelAfter) was not invoked when cancelAfter was invoked, but is set after the operation times out, it is reset by this method before it completes abruptly with a TestCanceledException. The interrupted status will be set by ThreadInterruptor, the default Interruptor implementation.

    timeout

    the maximimum amount of time allowed for the passed operation

    f

    the operation on which to enforce the passed timeout

    interruptor

    a strategy for interrupting the passed operation

    Definition Classes
    Timeouts
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. implicit val defaultInterruptor: Interruptor

    Permalink

    Implicit Interruptor value defining a default interruption strategy for the failAfter and cancelAfter method.

    Implicit Interruptor value defining a default interruption strategy for the failAfter and cancelAfter method.

    To change the default Interruptor configuration, override or hide this val with another implicit Interruptor.

    Definition Classes
    Timeouts
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def failAfter[T](timeout: Span)(fun: ⇒ T)(implicit interruptor: Interruptor, pos: Position = implicitly[source.Position]): T

    Permalink

    Executes the passed function, enforcing the passed time limit by attempting to interrupt the function if the time limit is exceeded, and throwing TestFailedDueToTimeoutException if the time limit has been exceeded after the function completes.

    Executes the passed function, enforcing the passed time limit by attempting to interrupt the function if the time limit is exceeded, and throwing TestFailedDueToTimeoutException if the time limit has been exceeded after the function completes.

    If the function completes before the timeout expires:

    • If the function returns normally, this method will return normally.
    • If the function completes abruptly with an exception, this method will complete abruptly with that same exception.

    If the function completes after the timeout expires:

    • If the function returns normally, this method will complete abruptly with a TestFailedDueToTimeoutException.
    • If the function completes abruptly with an exception, this method will complete abruptly with a TestFailedDueToTimeoutException that includes the exception thrown by the function as its cause.

    If the interrupted status of the main test thread (the thread that invoked failAfter) was not invoked when failAfter was invoked, but is set after the operation times out, it is reset by this method before it completes abruptly with a TestFailedDueToTimeoutException. The interrupted status will be set by ThreadInterruptor, the default Interruptor implementation.

    timeout

    the maximimum amount of time allowed for the passed operation

    fun

    the operation on which to enforce the passed timeout

    interruptor

    a strategy for interrupting the passed operation

    Definition Classes
    Timeouts
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Timeouts

Inherited from AnyRef

Inherited from Any

Ungrouped