org.scalatest.concurrent

Timeouts

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

Alphabetic
By inheritance

Inherited

Timeouts
Timeouts
AnyRef
Any

Hide All
Show all

Learn more about member selection

Visibility

Public
All

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def cancelAfter[T](timeout: Span)(f: ⇒ T)(implicit interruptor: Interruptor): T

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
def clone(): AnyRef

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

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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def failAfter[T](timeout: Span)(fun: ⇒ T)(implicit interruptor: Interruptor): T

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
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws()

Inherited from Timeouts

Inherited from AnyRef

Inherited from Any

Ungrouped