commonMain.dk.cachet.carp.common.application.tasks.BackgroundTask.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carp.common

Helper classes and base types relied upon by all subsystems. This library does not contain any domain logic.

The newest version!

@file:Suppress( "NON_EXPORTABLE_TYPE" )

package dk.cachet.carp.common.application.tasks

import dk.cachet.carp.common.application.data.NoData
import dk.cachet.carp.common.infrastructure.serialization.DurationSerializer
import kotlinx.serialization.*
import kotlin.js.JsExport
import kotlin.time.Duration


/**
 * A [TaskConfiguration] which specifies that all containing measures and/or outputs should immediately start running
 * in the background once triggered.
 * The task runs for the specified [duration], or until stopped, or until all measures and/or outputs have completed.
 *
 * TODO: Outputs are not yet specified.
 */
@Serializable
@JsExport
data class BackgroundTask(
    override val name: String,
    override val measures: List = emptyList(),
    override val description: String? = null,
    /**
     * The optional duration over the course of which the [measures] need to be sampled.
     * Infinite by default.
     */
    @Serializable( DurationSerializer::class )
    val duration: Duration = Duration.INFINITE
) : TaskConfiguration // Not an interactive task, so uploads no data other than measures.


/**
 * A helper class to configure and construct immutable [BackgroundTask] instances.
 */
@JsExport
class BackgroundTaskBuilder(
    /**
     * The optional duration over the course of which the [measures] need to be sampled.
     * Infinite by default.
     */
    var duration: Duration = Duration.INFINITE
) : TaskConfigurationBuilder()
{
    override fun build( name: String ): BackgroundTask =
        BackgroundTask( name, measures, description, duration )
}