core/io.neuralheads.kmpworker.core/TaskState

TaskState

Represents the current lifecycle state of a background task.

State machine:

[Scheduled] → [Running] → [Success]
                        ↘ [Failed]
                        ↘ [TimedOut]   (task exceeded KmpWorkerConfig.taskTimeout)
[Scheduled] → [Cancelled]   (before execution begins)

Inheritors

Types

Cancelled

data class Cancelled(val reason: String = "") : TaskState

Task was explicitly cancelled via KmpWorker.cancel. No retry will occur after cancellation.

Failed

data class Failed(val throwable: Throwable, val retryCount: Int = 0, val willRetry: Boolean = false) : TaskState

Task failed with an exception.

Running

data class Running(val progress: Float? = null, val message: String? = null) : TaskState

Task handler is currently executing.

Scheduled

data object Scheduled : TaskState

Task has been accepted and queued for execution.

Success

data object Success : TaskState

Task completed successfully.

TimedOut

data class TimedOut(val afterMillis: Long) : TaskState

Task exceeded the KmpWorkerConfig.taskTimeout duration and was stopped. No retry will occur after a timeout — treat the same as Cancelled.

Properties

isActive

val isActive: Boolean

True if the task is currently active (Scheduled or Running).

isTerminal

val isTerminal: Boolean

True if the task is in a terminal state (Success, Failed without retry, Cancelled, or TimedOut).