From 8a9f5573bef3f68316add17c04a47cc4e5fe75fa Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Thu, 1 Oct 2020 00:49:53 +0200 Subject: Move OpenDC modules into simulator root This change moves the OpenDC modules previously living in the simulator/opendc directory to the simulator directory itself given that we do not make a distinction between OpenDC and odcsim anymore. --- .../main/kotlin/org/opendc/utils/flow/EventFlow.kt | 96 ++++++++++++++++++++++ .../main/kotlin/org/opendc/utils/flow/StateFlow.kt | 79 ++++++++++++++++++ 2 files changed, 175 insertions(+) create mode 100644 simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/EventFlow.kt create mode 100644 simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/StateFlow.kt (limited to 'simulator/opendc-utils/src/main') diff --git a/simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/EventFlow.kt b/simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/EventFlow.kt new file mode 100644 index 00000000..948595b1 --- /dev/null +++ b/simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/EventFlow.kt @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2020 AtLarge Research + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package org.opendc.utils.flow + +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.FlowPreview +import kotlinx.coroutines.InternalCoroutinesApi +import kotlinx.coroutines.channels.Channel +import kotlinx.coroutines.channels.SendChannel +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.FlowCollector +import kotlinx.coroutines.flow.consumeAsFlow + +/** + * A [Flow] that can be used to emit events. + */ +public interface EventFlow : Flow { + /** + * Emit the specified [event]. + */ + public fun emit(event: T) + + /** + * Close the flow. + */ + public fun close() +} + +/** + * Creates a new [EventFlow]. + */ +@Suppress("FunctionName") +public fun EventFlow(): EventFlow = EventFlowImpl() + +/** + * Internal implementation of the [EventFlow] class. + */ +@OptIn(ExperimentalCoroutinesApi::class, FlowPreview::class) +private class EventFlowImpl : EventFlow { + private var closed: Boolean = false + private val subscribers = HashMap, Unit>() + + override fun emit(event: T) { + synchronized(this) { + for ((chan, _) in subscribers) { + chan.offer(event) + } + } + } + + override fun close() { + synchronized(this) { + closed = true + + for ((chan, _) in subscribers) { + chan.close() + } + } + } + + @InternalCoroutinesApi + override suspend fun collect(collector: FlowCollector) { + val channel: Channel + synchronized(this) { + if (closed) { + return + } + + channel = Channel(Channel.UNLIMITED) + subscribers[channel] = Unit + } + channel.consumeAsFlow().collect(collector) + } + + override fun toString(): String = "EventFlow" +} diff --git a/simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/StateFlow.kt b/simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/StateFlow.kt new file mode 100644 index 00000000..996e7700 --- /dev/null +++ b/simulator/opendc-utils/src/main/kotlin/org/opendc/utils/flow/StateFlow.kt @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2020 AtLarge Research + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package org.opendc.utils.flow + +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.FlowPreview +import kotlinx.coroutines.InternalCoroutinesApi +import kotlinx.coroutines.channels.BroadcastChannel +import kotlinx.coroutines.channels.ConflatedBroadcastChannel +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.FlowCollector +import kotlinx.coroutines.flow.asFlow + +/** + * A [Flow] that contains a single value that changes over time. + * + * This class exists to implement the DataFlow/StateFlow functionality that will be implemented in `kotlinx-coroutines` + * in the future, but is not available yet. + * See: https://github.com/Kotlin/kotlinx.coroutines/pull/1354 + */ +public interface StateFlow : Flow { + /** + * The current value of this flow. + * + * Setting a value that is [equal][Any.equals] to the previous one does nothing. + */ + public var value: T +} + +/** + * Creates a [StateFlow] with a given initial [value]. + */ +@Suppress("FunctionName") +public fun StateFlow(value: T): StateFlow = StateFlowImpl(value) + +/** + * Internal implementation of the [StateFlow] interface. + */ +@OptIn(ExperimentalCoroutinesApi::class, FlowPreview::class) +private class StateFlowImpl(initialValue: T) : StateFlow { + /** + * The [BroadcastChannel] to back this flow. + */ + private val chan = ConflatedBroadcastChannel(initialValue) + + /** + * The internal [Flow] backing this flow. + */ + private val flow = chan.asFlow() + + public override var value: T = initialValue + set(value) { + chan.offer(value) + field = value + } + + @InternalCoroutinesApi + override suspend fun collect(collector: FlowCollector) = flow.collect(collector) +} -- cgit v1.2.3