Add direct property cache write ability

Author: altavir

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/DeviceGroup.kt

@@ -7,6 +7,7 @@ import space.kscience.controls.api.LifecycleState.*
 import space.kscience.controls.manager.DeviceManager
 import space.kscience.controls.manager.install
 import space.kscience.controls.spec.DevicePropertySpec
+import space.kscience.controls.spec.InternalDeviceAPI
 import space.kscience.controls.time.clock
 import space.kscience.dataforge.context.*
 import space.kscience.dataforge.meta.Laminate
@@ -151,9 +152,10 @@ public open class DeviceGroup(
         properties[propertyName.parseAsName()]?.valueAsMeta
             ?: error("Property with name $propertyName not found")
 
-    override fun getProperty(propertyName: String): Meta? = properties[propertyName.parseAsName()]?.valueAsMeta
+    override fun getCachedProperty(propertyName: String): Meta? = properties[propertyName.parseAsName()]?.valueAsMeta
 
-    override suspend fun invalidate(propertyName: String) {
+    @InternalDeviceAPI
+    override fun setCachedProperty(propertyName: String, value: Meta?) {
         //does nothing for this implementation
     }
 
@@ -199,9 +201,7 @@ public open class DeviceGroup(
 
     override val clock: Clock = context.clock
 
-    public companion object {
-
-    }
+    public companion object
 }
 
 public fun <T> DeviceGroup.registerAsProperty(propertySpec: DevicePropertySpec<*, T>, state: DeviceState<T>) {

controls-core/src/commonMain/kotlin/space/kscience/controls/api/Device.kt

@@ -5,6 +5,7 @@ import kotlinx.coroutines.Job
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.flow.*
 import space.kscience.controls.api.Device.Companion.DEVICE_TARGET
+import space.kscience.controls.spec.InternalDeviceAPI
 import space.kscience.dataforge.context.ContextAware
 import space.kscience.dataforge.context.info
 import space.kscience.dataforge.context.logger
@@ -100,21 +101,31 @@ public interface CachingDevice : Device {
     /**
      * Immediately (without waiting) get the cached (logical) state of property or return null if it is invalid
      */
-    public fun getProperty(propertyName: String): Meta?
+    public fun getCachedProperty(propertyName: String): Meta?
+
+    /**
+     * Immediately (without waiting) set the cached (logical) state of a property to a specific value
+     * or remove cached value (if [value] is null).
+     *
+     * This method is not thread-safe and should be used with care. Preferably only for internal APIs
+     */
+    @InternalDeviceAPI
+    public fun setCachedProperty(propertyName: String, value: Meta?)
 
     /**
      * Invalidate property (set logical state to invalid).
      *
      * This message is suspended to provide lock-free local property changes (they require coroutine context).
      */
-    public suspend fun invalidate(propertyName: String)
+    @OptIn(InternalDeviceAPI::class)
+    public suspend fun invalidate(propertyName: String): Unit = setCachedProperty(propertyName, null)
 }
 
 /**
  * Get the logical state of property or suspend to read the physical value.
  */
 public suspend fun Device.getOrReadProperty(propertyName: String): Meta = if (this is CachingDevice) {
-    getProperty(propertyName) ?: readProperty(propertyName)
+    getCachedProperty(propertyName) ?: readProperty(propertyName)
 } else {
     readProperty(propertyName)
 }
@@ -125,7 +136,7 @@ public suspend fun Device.getOrReadProperty(propertyName: String): Meta = if (th
  */
 public fun CachingDevice.getAllProperties(): Meta = Meta {
     for (descriptor in propertyDescriptors) {
-        set(descriptor.name.parseAsName(), getProperty(descriptor.name))
+        set(descriptor.name.parseAsName(), getCachedProperty(descriptor.name))
     }
 }
 

controls-core/src/commonMain/kotlin/space/kscience/controls/spec/DeviceBase.kt

@@ -151,7 +151,16 @@ public abstract class DeviceBase<D : Device>(
         return meta
     }
 
-    override fun getProperty(propertyName: String): Meta? = logicalState[propertyName]
+    override fun getCachedProperty(propertyName: String): Meta? = logicalState[propertyName]
+
+    @InternalDeviceAPI
+    override fun setCachedProperty(propertyName: String, value: Meta?) {
+        if (value == null) {
+            logicalState.remove(propertyName)
+        } else {
+            logicalState[propertyName] = value
+        }
+    }
 
     override suspend fun invalidate(propertyName: String) {
         stateLock.withLock {

controls-magix/src/commonMain/kotlin/space/kscience/controls/client/DeviceClient.kt

@@ -11,6 +11,7 @@ import kotlinx.coroutines.sync.withLock
 import space.kscience.controls.api.*
 import space.kscience.controls.manager.DeviceManager
 import space.kscience.controls.spec.DevicePropertySpec
+import space.kscience.controls.spec.InternalDeviceAPI
 import space.kscience.controls.spec.name
 import space.kscience.controls.time.clock
 import space.kscience.dataforge.context.Context
@@ -76,7 +77,16 @@ public class DeviceClient internal constructor(
         }.value
     }
 
-    override fun getProperty(propertyName: String): Meta? = propertyCache[propertyName]
+    override fun getCachedProperty(propertyName: String): Meta? = propertyCache[propertyName]
+
+    @InternalDeviceAPI
+    override fun setCachedProperty(propertyName: String, value: Meta?) {
+        if (value == null) {
+            propertyCache.remove(propertyName)
+        } else {
+            propertyCache[propertyName] = value
+        }
+    }
 
     override suspend fun invalidate(propertyName: String) {
         mutex.withLock {
@@ -138,7 +148,7 @@ public suspend fun MagixEndpoint.remoteDevice(
         .map { it.second }
         .filter {
             it.sourceDevice == null || it.sourceDevice == deviceName
-        }.shareIn(context, SharingStarted.Lazily,10)
+        }.shareIn(context, SharingStarted.Lazily, 10)
 
     val deferredDescriptorMessage = CompletableDeferred<DescriptionMessage>()