core/io.neuralheads.kmpworker.core/TaskExecutionContext

TaskExecutionContext

data class TaskExecutionContext(val taskId: String, val retryCount: Int = 0, val payload: String? = null, val tags: Set<String> = emptySet())

Context provided to a task handler at execution time.

Available as the receiver inside handlers registered with context support:

kmpWorker.register("upload") { ctx ->
    val data = ctx.payload?.let { Json.decodeFromString<MyData>(it) }
    println("Attempt ${ctx.retryCount + 1} for ${ctx.taskId}")
    uploadService.upload(data)
}

Parameters

taskId

The unique ID of the task currently executing.

retryCount

Zero-based number of times this task has been retried.

payload

Optional serialized data from TaskRequest.payload.

Constructors

TaskExecutionContext

constructor(taskId: String, retryCount: Int = 0, payload: String? = null, tags: Set<String> = emptySet())

Properties

isFirstAttempt

val isFirstAttempt: Boolean

Returns true if this is the first execution attempt (not a retry).

isRetry

val isRetry: Boolean

Returns true if this is a retry attempt.

payload

val payload: String? = null

retryCount

val retryCount: Int = 0

Functions

decodePayload

inline fun <T> TaskExecutionContext.decodePayload(): T?

Decodes the payload of this TaskExecutionContext into a strongly-typed object.

reportProgress

suspend fun reportProgress(progress: Float, message: String? = null)

Reports progress from within a task handler.