val id: Int
Name of the worker, as specified in Worker.start or "worker $id" by default,
val name: String
Get platform thread id of the worker thread.
val platformThreadId: ULong
Convert worker to a COpaquePointer value that could be passed via native void* pointer. Can be used as an argument of Worker.fromCPointer.
Plan job for further execution in the worker. Execute is a two-phase operation:
fun <T1, T2> execute(
producer: () -> T1,
job: (T1) -> T2
Plan job for further execution in the worker.
afterMicroseconds: Long = 0,
operation: () -> Unit)
Park execution of the current worker until a new request arrives or timeout specified in timeoutMicroseconds elapsed. If process is true, pending queue elements are processed, including delayed requests. Note that multiple requests could be processed this way.
process: Boolean = false
Process pending job(s) on the queue of this worker. Note that jobs scheduled with executeAfter using non-zero timeout are not processed this way. If termination request arrives while processing the queue via this API, worker is marked as terminated and will exit once the current request is done with.
fun processQueue(): Boolean
Requests termination of the worker.
processScheduledJobs: Boolean = true
String representation of the worker.
fun toString(): String
Companion Object Properties
Return the current worker. Worker context is accessible to any valid Kotlin context, but only actual active worker produced with Worker.start automatically processes execution requests. For other situations processQueue must be called explicitly to process request queue.
val current: Worker
Companion Object Functions
Create worker object from a C pointer.
fromCPointer(pointer: COpaquePointer?): Worker
Start new scheduling primitive, such as thread, to accept new tasks via
Typically new worker may be needed for computations offload to another core, for IO it may be
better to use non-blocking IO combined with more lightweight coroutines.
errorReporting: Boolean = true,
name: String? = null