Package org.apache.pekko.testkit

Class Coroner$

java.lang.Object

org.apache.pekko.testkit.Coroner$

public class Coroner$
extends Object

The Coroner can be used to print a diagnostic report of the JVM state, including stack traces and deadlocks. A report can be printed directly, by calling printReport. Alternatively, the Coroner can be asked to watch the JVM and generate a report at a later time - unless the Coroner is cancelled by that time.

The latter method is useful for printing diagnostics in the event that, for example, a unit test stalls and fails to cancel the Coroner in time. The Coroner will assume that the test has "died" and print a report to aid in debugging.

Field Summary

Fields

Modifier and Type	Field	Description
static final Coroner$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
Coroner$()

Method Summary

Modifier and Type	Method	Description
scala.concurrent.duration.FiniteDuration	defaultStartAndStopDuration()
void	printReport(String reportTitle, PrintStream out)	Print a report containing diagnostic information.
Coroner.WatchHandle	watch(scala.concurrent.duration.FiniteDuration duration, String reportTitle, PrintStream out, scala.concurrent.duration.FiniteDuration startAndStopDuration, boolean displayThreadCounts)	Ask the Coroner to print a report if it is not cancelled by the given deadline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE$

public static final Coroner$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

Coroner$

public Coroner$()

Method Details

defaultStartAndStopDuration

public scala.concurrent.duration.FiniteDuration defaultStartAndStopDuration()

watch

public Coroner.WatchHandle watch(scala.concurrent.duration.FiniteDuration duration,
 String reportTitle,
 PrintStream out,
 scala.concurrent.duration.FiniteDuration startAndStopDuration,
 boolean displayThreadCounts)

Ask the Coroner to print a report if it is not cancelled by the given deadline. The returned handle can be used to perform the cancellation.

If displayThreadCounts is set to true, then the Coroner will print thread counts during start and stop.

Parameters:

duration - (undocumented)

reportTitle - (undocumented)

out - (undocumented)

startAndStopDuration - (undocumented)

displayThreadCounts - (undocumented)

Returns:

(undocumented)

printReport

public void printReport(String reportTitle,
 PrintStream out)

Print a report containing diagnostic information.

Parameters:

reportTitle - (undocumented)

out - (undocumented)