core/pro.respawn.flowmvi.plugins/JobManager

JobManager

An entity that manages running jobs. Used with jobManagerPlugin and manageJobs. Will cancel and remove all jobs if the parent pro.respawn.flowmvi.api.Store is closed

Constructors

JobManager

constructor()

Properties

activeJobs

val activeJobs: Collection<Job>

Returns a read-only view of the currently active jobs.

hasJobs

val hasJobs: Boolean

Returns true if this manager has any active jobs, false otherwise.

Functions

cancel

@IgnorableReturnValue

fun cancel(key: K): Job?

Cancel a job with the specified key

cancelAll

@IgnorableReturnValue

fun cancelAll()

Cancels all jobs without suspending

cancelAndJoin

@IgnorableReturnValue

suspend fun cancelAndJoin(key: K): Job?

Cancel and join a job for key if it is present

cancelAndJoinAll

@IgnorableReturnValue

suspend fun cancelAndJoinAll()

Cancels all jobs in parallel and then joins them all sequentially

get

operator fun get(key: K): Job?

Get a job for the specified key.

invoke

@IgnorableReturnValue

operator fun invoke(key: K, job: Job)

Alias for set and put.

join

@IgnorableReturnValue

suspend fun join(key: K): Job?

Join the job for key if it is present.

joinAll

@IgnorableReturnValue

suspend fun joinAll()

Joins all jobs sequentially

@IgnorableReturnValue

suspend fun joinAll(vararg keys: K)

Joins all jobs specified in keys in the declaration order

put

@IgnorableReturnValue

fun put(key: K, job: Job)

Put a job into the container and throw IllegalArgumentException if the job with the same key is already running.

putAll

@IgnorableReturnValue

fun putAll(vararg jobs: Pair<K, Job>)

Put all jobs into the storage.

putOrReplace

@IgnorableReturnValue

suspend fun putOrReplace(key: K, job: Job): Job?

Put a job into the container and call Job.cancelAndJoin if one already exists there.

set

@IgnorableReturnValue

operator fun set(key: K, value: Job)

Alias for put. Will throw if a job with the same key already exists.

start

@IgnorableReturnValue

fun start(key: K): Job?

Start the job with key if it is present.