runner-api/dev.ust.zinc.grader.pipeline/PipelineStage

PipelineStage

abstract class PipelineStage(val inType: KClass<out StageResult>, val outType: KClass<out StageResult>) : StateTraceable<PipelineStage.ExecStateData, Unit>

Inheritors

Constructors

PipelineStage

constructor(inType: KClass<out StageResult>, outType: KClass<out StageResult>)

Types

EmptyConfig

open class EmptyConfig : ConfigUnit

A ConfigUnit which represents an empty configuration.

ExecStateData

abstract class ExecStateData

Execution data associated to a PipelineStage.

Kind

enum Kind : Enum<PipelineStage.Kind>

Classification of this stage.

Properties

_runner

protected lateinit var _runner: Runner

className

open val className: String

The class name of this pipeline stage.

config

abstract val config: ConfigUnit

The configuration used to instantiate this stage.

configKeySrc

val configKeySrc: String?

The key of the configuration which instantiated this stage.

hasTimedOut

protected var hasTimedOut: Boolean

Whether this stage has timed out.

inType

val inType: KClass<out StageResult>

logger

protected val logger: Logger

outType

val outType: KClass<out StageResult>

parserContext

protected var parserContext: ConfigParsable.Context?

The context of the configuration parser associated with instantiating this stage.

pipelinePath

val pipelinePath: String

The unique stage name of this pipeline stage.

runner

open val runner: Runner

traceableState

open override val traceableState: AtomicReference<TraceableState<PipelineStage.ExecStateData, Unit>>

Functions

execute

protected abstract suspend fun execute(input: StageResult): StageResult

Implementation for executing this pipeline.

execWithInput

suspend fun execWithInput(input: StageResult): StageResult

Executes this pipeline stage using input.

markStageAsTimedOut

protected fun markStageAsTimedOut()

Marks this stage as having timed out.

onExecComplete

@MustBeInvokedByOverriders

protected open suspend fun onExecComplete()

Callback method to run when execute method completes, regardless of whether it succeeds or fails.

onExecFailed

protected fun onExecFailed(tr: Throwable)

Callback method to run when the execute method fails.

onExecFailedImpl

protected abstract fun onExecFailedImpl(tr: Throwable)

Implementation for when the execute method fails.

onInitParserContext

protected open fun onInitParserContext(configContext: ConfigParsable.Context)

Implementation when parser context is provided to the stage.

putParserContext

fun putParserContext(configContext: ConfigParsable.Context)

Provides the parser context to this pipeline stage.

putRunner

fun putRunner(runner: Runner)

Puts the context of the Runner into this pipeline stage.