orbit-util

alltypes

object AnnotationUtils

fun <A : Annotation> findAnnotationInTree(clazz: Class<*>, annotation: Class<A>): A?
fun <A : Annotation> isAnnotationInTree(clazz: Class<*>, annotation: Class<A>): Boolean

interface AsyncMap<K, V>

abstract suspend fun compareAndSet(key: K, initialValue: V?, newValue: V?): Boolean
open suspend fun count(): Int
abstract suspend fun entries(): Iterable<Pair<K, V>>
abstract suspend fun get(key: K): V?
open suspend fun getOrPut(key: K, block: suspend () -> V): V
open suspend fun getValue(key: K): V
open suspend fun manipulate(key: K, block: (V?) -> V?): V?
abstract suspend fun remove(key: K): Boolean
abstract suspend fun set(key: K, value: V): Unit
open suspend fun values(): List<V>

class Clock

Clock()
fun advanceTime(offset: TimeMs): Unit
val currentTime: TimeMs
fun inFuture(time: Timestamp): Boolean
fun inPast(time: Timestamp): Boolean
fun now(): Instant!
fun nowOrPast(time: Timestamp): Boolean
fun resetToNow(): Unit

object ClockUtils

fun currentTimeMillis(): Long

class ComponentContainer

ComponentContainer()
inline fun configure(config: ComponentContainerRoot.() -> Unit): Unit
fun <T> construct(concreteClass: Class<out T>): T
fun <reified T> construct(): T
fun <reified R : Any> inject(): Lazy<R>
fun <T : Any> register(type: Class<T>, factory: (ComponentContainer) -> T): Unit
data class Registration<T>

Registration(type: Class<T>, factory: (ComponentContainer) -> T)
val factory: (ComponentContainer) -> T
val type: Class<T>

fun <T> resolve(type: Class<T>): T
fun <reified R : Any> resolve(): R

class ComponentContainerRoot

ComponentContainerRoot(container: ComponentContainer)
val container: ComponentContainer
fun <reified T : Any> externallyConfigured(config: ExternallyConfigured<T>): Unit
fun <reified T : Any> instance(instance: T): Unit
inline fun <reified T : Any> register(crossinline body: (ComponentContainer) -> T): Unit
inline fun <reified T : Any> register(crossinline body: () -> T): Unit
fun <reified T : Any> resolve(): T
fun <reified T : Any> singleton(clazz: Class<out T>): Unit
fun <reified T : Any> singleton(): Unit

class ConstantTicker

ConstantTicker(scope: CoroutineScope, targetTickRate: Long, clock: Clock, logger: KLogger? = null, exceptionHandler: ((Throwable) -> Unit)? = null, autoStart: Boolean = false, onTick: suspend () -> Unit, onSlowTick: suspend () -> Unit = {})
fun start(): Unit
fun stop(): Unit

data class ElapsedAndResult<T>

ElapsedAndResult(elapsed: TimeMs, result: T)
val elapsed: TimeMs
val result: T

interface ExternallyConfigured<T>

abstract val instanceType: Class<out T>

abstract class HashMapBackedAsyncMap<K, V> : AsyncMap<K, V>

HashMapBackedAsyncMap()
open suspend fun compareAndSet(key: K, initialValue: V?, newValue: V?): Boolean
open suspend fun entries(): Iterable<Pair<K, V>>
open suspend fun get(key: K): V?
abstract val map: ConcurrentHashMap<K, V>
open suspend fun remove(key: K): Boolean
open suspend fun set(key: K, value: V): Unit

io.micrometer.core.instrument.Timer

suspend fun <R> Timer.recordSuspended(f: suspend () -> R): R

java.time.Instant

fun Instant.toTimestamp(): Timestamp

java.util.concurrent.atomic.AtomicReference

inline fun <T> AtomicReference<T>.atomicSet(crossinline block: (T) -> T): T

kotlin.collections.Collection

fun <E> Collection<E>.randomOrNull(): E?

object Pools

@JvmStatic fun createCachedPool(threadPrefix: String): CoroutineDispatcher
@JvmStatic @JvmOverloads fun createFixedPool(threadPrefix: String, maxThreads: Int = defaultParallelism): CoroutineDispatcher
@JvmStatic val defaultParallelism: Int

class RailWorker<T>

RailWorker(scope: CoroutineScope, buffer: Int = 10_000, railCount: Int = 128, logger: KLogger? = null, autoStart: Boolean = false, onMessage: suspend (T) -> Unit)
val isInitialized: Boolean
fun offer(msg: T): Boolean
suspend fun send(msg: T): Unit
fun startWorkers(): Unit
fun stopWorkers(): Unit

class RetriesExceededException : Exception

RetriesExceededException(msg: String)

object RNGUtils

fun randomString(numChars: Int = 16, random: Random = Random.Default): String

class ShutdownLatch

ShutdownLatch()
fun acquire(): Unit
fun release(): Unit

class Stopwatch

val elapsed: TimeMs
@JvmStatic fun start(clock: Clock): Stopwatch

class SupervisorScope : CoroutineScope

SupervisorScope(pool: CoroutineDispatcher, exceptionHandler: (CoroutineContext, Throwable) -> Unit)
val coroutineContext: CoroutineContext

typealias TimeMs = Long
data class Timestamp

Timestamp(seconds: Long, nanos: Int)
operator fun compareTo(timestamp: Timestamp): Int
fun isAfter(time: Instant): Boolean
fun isExactly(time: Instant): Boolean
val nanos: Int
fun now(): Timestamp
val seconds: Long

package orbit.util.concurrent

interface AsyncMap<K, V>

abstract suspend fun compareAndSet(key: K, initialValue: V?, newValue: V?): Boolean
open suspend fun count(): Int
abstract suspend fun entries(): Iterable<Pair<K, V>>
abstract suspend fun get(key: K): V?
open suspend fun getOrPut(key: K, block: suspend () -> V): V
open suspend fun getValue(key: K): V
open suspend fun manipulate(key: K, block: (V?) -> V?): V?
abstract suspend fun remove(key: K): Boolean
abstract suspend fun set(key: K, value: V): Unit
open suspend fun values(): List<V>

abstract class HashMapBackedAsyncMap<K, V> : AsyncMap<K, V>

HashMapBackedAsyncMap()
open suspend fun compareAndSet(key: K, initialValue: V?, newValue: V?): Boolean
open suspend fun entries(): Iterable<Pair<K, V>>
open suspend fun get(key: K): V?
abstract val map: ConcurrentHashMap<K, V>
open suspend fun remove(key: K): Boolean
open suspend fun set(key: K, value: V): Unit

java.util.concurrent.atomic.AtomicReference

inline fun <T> AtomicReference<T>.atomicSet(crossinline block: (T) -> T): T

object Pools

@JvmStatic fun createCachedPool(threadPrefix: String): CoroutineDispatcher
@JvmStatic @JvmOverloads fun createFixedPool(threadPrefix: String, maxThreads: Int = defaultParallelism): CoroutineDispatcher
@JvmStatic val defaultParallelism: Int

class RailWorker<T>

RailWorker(scope: CoroutineScope, buffer: Int = 10_000, railCount: Int = 128, logger: KLogger? = null, autoStart: Boolean = false, onMessage: suspend (T) -> Unit)
val isInitialized: Boolean
fun offer(msg: T): Boolean
suspend fun send(msg: T): Unit
fun startWorkers(): Unit
fun stopWorkers(): Unit

class ShutdownLatch

ShutdownLatch()
fun acquire(): Unit
fun release(): Unit

class SupervisorScope : CoroutineScope

SupervisorScope(pool: CoroutineDispatcher, exceptionHandler: (CoroutineContext, Throwable) -> Unit)
val coroutineContext: CoroutineContext

package orbit.util.di

class ComponentContainer

ComponentContainer()
inline fun configure(config: ComponentContainerRoot.() -> Unit): Unit
fun <T> construct(concreteClass: Class<out T>): T
fun <reified T> construct(): T
fun <reified R : Any> inject(): Lazy<R>
fun <T : Any> register(type: Class<T>, factory: (ComponentContainer) -> T): Unit
data class Registration<T>

Registration(type: Class<T>, factory: (ComponentContainer) -> T)
val factory: (ComponentContainer) -> T
val type: Class<T>

fun <T> resolve(type: Class<T>): T
fun <reified R : Any> resolve(): R

class ComponentContainerRoot

ComponentContainerRoot(container: ComponentContainer)
val container: ComponentContainer
fun <reified T : Any> externallyConfigured(config: ExternallyConfigured<T>): Unit
fun <reified T : Any> instance(instance: T): Unit
inline fun <reified T : Any> register(crossinline body: (ComponentContainer) -> T): Unit
inline fun <reified T : Any> register(crossinline body: () -> T): Unit
fun <reified T : Any> resolve(): T
fun <reified T : Any> singleton(clazz: Class<out T>): Unit
fun <reified T : Any> singleton(): Unit

interface ExternallyConfigured<T>

abstract val instanceType: Class<out T>

package orbit.util.instrumentation

io.micrometer.core.instrument.Timer

suspend fun <R> Timer.recordSuspended(f: suspend () -> R): R

package orbit.util.misc

suspend inline fun <T> attempt(maxAttempts: Int = 5, initialDelay: Long = 1000, maxDelay: Long = Long.MAX_VALUE, factor: Double = 1.0, logger: KLogger? = null, body: () -> T): T
kotlin.collections.Collection

fun <E> Collection<E>.randomOrNull(): E?

class RetriesExceededException : Exception

RetriesExceededException(msg: String)

suspend fun <T> retry(retryDelay: Duration = Duration.ZERO, attempts: Int = Int.MAX_VALUE, action: suspend () -> T): T?
object RNGUtils

fun randomString(numChars: Int = 16, random: Random = Random.Default): String

package orbit.util.reflect

object AnnotationUtils

fun <A : Annotation> findAnnotationInTree(clazz: Class<*>, annotation: Class<A>): A?
fun <A : Annotation> isAnnotationInTree(clazz: Class<*>, annotation: Class<A>): Boolean

package orbit.util.time

class Clock

Clock()
fun advanceTime(offset: TimeMs): Unit
val currentTime: TimeMs
fun inFuture(time: Timestamp): Boolean
fun inPast(time: Timestamp): Boolean
fun now(): Instant!
fun nowOrPast(time: Timestamp): Boolean
fun resetToNow(): Unit

object ClockUtils

fun currentTimeMillis(): Long

class ConstantTicker

ConstantTicker(scope: CoroutineScope, targetTickRate: Long, clock: Clock, logger: KLogger? = null, exceptionHandler: ((Throwable) -> Unit)? = null, autoStart: Boolean = false, onTick: suspend () -> Unit, onSlowTick: suspend () -> Unit = {})
fun start(): Unit
fun stop(): Unit

data class ElapsedAndResult<T>

ElapsedAndResult(elapsed: TimeMs, result: T)
val elapsed: TimeMs
val result: T

@ExperimentalCoroutinesApi fun highResolutionTicker(ticksPerSecond: Double, scope: CoroutineScope = GlobalScope): ReceiveChannel<Unit>
java.time.Instant

fun Instant.toTimestamp(): Timestamp

class Stopwatch

val elapsed: TimeMs
@JvmStatic fun start(clock: Clock): Stopwatch

inline fun <T> stopwatch(clock: Clock, body: (() -> TimeMs) -> T): ElapsedAndResult<T>
typealias TimeMs = Long
data class Timestamp

Timestamp(seconds: Long, nanos: Int)
operator fun compareTo(timestamp: Timestamp): Int
fun isAfter(time: Instant): Boolean
fun isExactly(time: Instant): Boolean
val nanos: Int
fun now(): Timestamp
val seconds: Long

fun Timestamp.toInstant(): Instant!