Class InitializationPipelineOutcome

The terminal state of one InitializationPipelineService.RunAsync invocation, readable by the game after boot: whether the run halted on a critical task failure, which task halted it, the exception that halted it, and the outcome counters. A halted run leaves Halted true, Succeeded false, and every task after HaltedTaskId counted in Skipped without ever having run. Succeeded carries the same verdict RunAsync returns, so a caller that kept only the outcome reads the same answer.

Inheritance

object

InitializationPipelineOutcome

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.InitializationPipeline.Domain.Entities

Assembly: Serenity.InitializationPipeline.Domain.dll

Syntax

public sealed class InitializationPipelineOutcome

Constructors

InitializationPipelineOutcome(bool, bool, bool, string, Exception, int, int, int, int, IReadOnlyList<InitializationPipelineTaskFailure>)

Initializes a new instance of the InitializationPipelineOutcome class.

Declaration

public InitializationPipelineOutcome(bool completed, bool succeeded, bool halted, string haltedTaskId, Exception haltError, int executed, int skipped, int failed, int totalTasks, IReadOnlyList<InitializationPipelineTaskFailure> failedTasks)

Parameters

Type	Name	Description
bool	completed	True once a run has finished, whether it succeeded, halted or was canceled.
bool	succeeded	True when every critical task succeeded — the verdict RunAsync returns.
bool	halted	True when a critical task failure stopped the run before its last task.
string	haltedTaskId	The id of the critical task that halted the run, or null.
Exception	haltError	The exception the halting task threw, or null.
int	executed	How many tasks ran to completion.
int	skipped	How many tasks were skipped, by policy or because the run halted before them.
int	failed	How many tasks threw.
int	totalTasks	How many tasks the run planned.
IReadOnlyList<InitializationPipelineTaskFailure>	failedTasks	Every task that threw, in run order.

Properties

Completed

Declaration

public bool Completed { get; }

Property Value

Type	Description
bool	True once a run has finished, whether it succeeded, halted or was canceled.

Degraded

Declaration

public bool Degraded { get; }

Property Value

Type	Description
bool	True when the boot finished but at least one non-critical task failed: the game runs with the subsystems those tasks install missing. Never true together with Halted, which is the harder verdict.

Executed

Declaration

public int Executed { get; }

Property Value

Type	Description
int	How many tasks ran to completion.

Failed

Declaration

public int Failed { get; }

Property Value

Type	Description
int	How many tasks threw.

FailedTasks

Declaration

public IReadOnlyList<InitializationPipelineTaskFailure> FailedTasks { get; }

Property Value

Type	Description
IReadOnlyList<InitializationPipelineTaskFailure>	Every task that threw, in run order — what a degraded boot names so the reader knows which subsystems are missing.

HaltError

Declaration

public Exception HaltError { get; }

Property Value

Type	Description
Exception	The exception the halting task threw, or null when nothing halted the run.

Halted

Declaration

public bool Halted { get; }

Property Value

Type	Description
bool	True when a critical task failure stopped the run before its last task.

HaltedTaskId

Declaration

public string HaltedTaskId { get; }

Property Value

Type	Description
string	The id of the critical task that halted the run, or null when nothing halted it.

NotStarted

The outcome of a pipeline that has not been run yet.

Declaration

public static InitializationPipelineOutcome NotStarted { get; }

Property Value

Type	Description
InitializationPipelineOutcome

Skipped

Declaration

public int Skipped { get; }

Property Value

Type	Description
int	How many tasks were skipped, by policy or because the run halted before them.

Succeeded

Declaration

public bool Succeeded { get; }

Property Value

Type	Description
bool	True when every critical task succeeded — the verdict RunAsync returns.

TotalTasks

Declaration

public int TotalTasks { get; }

Property Value

Type	Description
int	How many tasks the run planned.