commonMain.io.nacular.doodle.time.Clock.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-jvm Show documentation

A pure Kotlin, UI framework for the Web and Desktop

There is a newer version: 0.10.4

package io.nacular.doodle.time

import io.nacular.measured.units.Measure
import io.nacular.measured.units.Time

/**
 * Exposes the current epoch time that is useful for date related time operations.
 * This API is tied to a user's clock, so it should not be used when monotonicity is required.
 * It is also not guaranteed to be as high resolution as needed for precise time operations.
 *
 * Created by Nicholas Eddy on 10/19/17.
 */
public interface Clock {
    /** Current epoch time */
    public val epoch: Measure
}

/**
 * Provides a precise elapsed time that is useful for relative time measurements
 * that are not affected by the user's clock (i.e. time rollbacks).  The resolution of this
 * time is expected to be higher than [Clock.epoch].
 */
public interface Timer {
    public val now: Measure
}