bug(#3): Add timeout for experiments

This change adds a timeout for experiments, which allows the user to set
an upper bound on the duration of an experiment.

Closes #3

1 files changed, 11 insertions, 0 deletions

diff --git a/opendc-core/src/main/kotlin/nl/atlarge/opendc/platform/Experiment.kt b/opendc-core/src/main/kotlin/nl/atlarge/opendc/platform/Experiment.kt
index 225b2813..6aed5364 100644
--- a/opendc-core/src/main/kotlin/nl/atlarge/opendc/platform/Experiment.kt
+++ b/opendc-core/src/main/kotlin/nl/atlarge/opendc/platform/Experiment.kt
@@ -25,6 +25,7 @@
 package nl.atlarge.opendc.platform
 
 import nl.atlarge.opendc.kernel.Kernel
+import nl.atlarge.opendc.kernel.time.Duration
 
 /**
  * A blueprint for a reproducible simulation in a pre-defined setting.
@@ -36,6 +37,16 @@ interface Experiment<out T> {
 	 * Run the experiment on the specified simulation [Kernel].
 	 *
 	 * @param kernel The simulation kernel to run the experiment.
+	 * @return The result of the experiment.
 	 */
 	fun run(kernel: Kernel): T
+
+	/**
+	 * Run the experiment on the specified simulation [Kernel].
+	 *
+	 * @param kernel The simulation kernel to run the experiment.
+	 * @param timeout The maximum duration of the experiment before returning to the caller.
+	 * @return The result of the experiment or `null`.
+	 */
+	fun run(kernel: Kernel, timeout: Duration): T?
 }