date-time/com.splendo.kaluga.datetime.timer/ControllableTimer

ControllableTimer

interface ControllableTimer : Timer

A Timer ticking a certain duration with the ability to start, pause and stop.

Inheritors

Properties

abstract val currentState: Timer.State

The current State of the timer.

abstract val duration: Duration

Timer Duration.

abstract val state: Flow<Timer.State>

Flow of State of the timer.

Functions

suspend fun Timer.awaitFinish()

Awaits for the Timer to reach the Timer.State.NotRunning.Finished state.

fun Timer.elapsed(): Flow<Duration>

Duration that has elapsed while Timer.state was Timer.State.Running.

abstract suspend fun pause(): Boolean

Pauses the timer. Calling start again will make it resume.

abstract suspend fun start(): Boolean

Starts the timer.

abstract suspend fun stop()

Stops the timer causing it to finish. Calling start again will return false.