traitTimeouts extends AnyRef

This trait has been deprecated and will be removed in a later version of ScalaTest. Please use trait
TimeLimits instead.

TimeLimits differs from Timeouts in two ways. First, its behavior is driven by a Timed
typeclass, so that it can treat Futures (and FutureOutcomes) differently than
non-Futures. Second, where TimeoutsfailAfter and cancelAfter take an implicit
Interruptor strategy, the corresponding methods in TimeLimits take an implicit Signaler strategy.
Although the Signaler hierarchy corresponds exactly to the Interruptor hierarchy, the default is different.
For Timeouts, the default is ThreadInterruptor; For Signaler, the default is
DoNotSignal.

Trait that provides a failAfter and cancelAfter construct, which allows you to specify a time limit for an
operation passed as a by-name parameter, as well as a way to interrupt it if the operation exceeds its time limit.

The time limit is passed as the first parameter, as a Span. The operation is
passed as the second parameter. And an Interruptor, a strategy for interrupting the operation, is
passed as an implicit third parameter. Here's a simple example of its use:

The code passed via the by-name parameter to failAfter or cancelAfter will be executed by the thread that invoked
failAfter or cancelAfter, so that no synchronization is necessary to access variables declared outside the by-name.

var result = -1// No need to make this volatile
failAfter(100 millis) {
result = accessNetService()
}
result should be (99)

The failAfter or cancelAfter method will create a timer that runs on a different thread than the thread that
invoked failAfter or cancelAfter, so that it can detect when the timeout has expired and attempt to interrupt
the main thread. Because different operations can require different interruption strategies, the failAfter or cancelAfter
method accepts an implicit third parameter of type Interruptor that is responsible for interrupting
the main thread.

Configuring failAfter or cancelAfter with an Interruptor

This trait declares an implicit val named defaultInterruptor,
initialized with a ThreadInterruptor, which attempts to interrupt the main thread by invoking
Thread.interrupt. If you wish to use a different strategy, you can override this val (or hide
it, for example if you imported the members of Timeouts rather than mixing it in). Here's an example
in which the default interruption method is changed to DoNotInterrupt, which does not attempt to
interrupt the main thread in any way:

As with the default Interruptor, the above code will eventually produce a
TestFailedDueToTimeoutException with a message that indicates a timeout expired. However, instead
of throwing the exception after approximately 100 milliseconds, it will throw it after approximately 500 milliseconds.

This illustrates an important feature of failAfter and cancelAfter: it will throw a
TestFailedDueToTimeoutException (or TestCanceledException in case of cancelAfter)
if the code passed as the by-name parameter takes longer than the specified timeout to execute, even if it
is allowed to run to completion beyond the specified timeout and returns normally.

The default interruptor, invokes interrupt on the main test thread. This will
set the interrupted status for the main test thread and,
if the main thread is blocked, will in some cases cause the main thread to complete abruptly with
an InterruptedException.

Invokes close on the java.io.Socket, which
will cause the main thread, if blocked in a read or write of an java.io.InputStream or
java.io.OutputStream that uses the Socket, to complete abruptly with a
SocketException.

You may wish to create your own Interruptor in some situations. For example, if your operation is performing
a loop and can check a volatile flag each pass through the loop. You could in that case write an Interruptor that
sets that flag so that the next time around, the loop would exit.

final defasInstanceOf[T0]: T0

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.

defequals(arg0: Any): Boolean

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.