/* * Copyright (C) 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package androidx.lifecycle import androidx.annotation.RestrictTo import androidx.annotation.VisibleForTesting import androidx.annotation.WorkerThread import androidx.arch.core.executor.ArchTaskExecutor import java.util.concurrent.Executor import java.util.concurrent.atomic.AtomicBoolean /** * A LiveData class that can be invalidated & computed when there are active observers. * * It can be invalidated via [invalidate], which will result in a call to * [compute] if there are active observers (or when they start observing) * * This is an internal class for now, might be public if we see the necessity. * * @param The type of the live data * @hide internal */ @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX) abstract class ComputableLiveData @JvmOverloads /** * Creates a computable live data that computes values on the specified executor * or the arch IO thread executor by default. * * @param executor Executor that is used to compute new LiveData values. */ constructor( internal val executor: Executor = ArchTaskExecutor.getIOThreadExecutor() ) { private val _liveData: LiveData = object : LiveData() { override fun onActive() { executor.execute(refreshRunnable) } } /** * The LiveData managed by this class. */ open val liveData: LiveData = _liveData internal val invalid = AtomicBoolean(true) internal val computing = AtomicBoolean(false) @JvmField @VisibleForTesting internal val refreshRunnable = Runnable { var computed: Boolean do { computed = false // compute can happen only in 1 thread but no reason to lock others. if (computing.compareAndSet(false, true)) { // as long as it is invalid, keep computing. try { var value: T? = null var once = true; var last = android.os.SystemClock.elapsedRealtime() while (invalid.compareAndSet(true, false)) { var now = android.os.SystemClock.elapsedRealtime() if (value != null && (once || last + 2500 < now)) { eu.faircode.email.Log.i(liveData.toString() + " post once=" + once + " age=" + (now - last) + " ms") once = false; last = now; liveData.postValue(value); } computed = true value = compute() } if (computed) { liveData.postValue(value) } } catch (ex: Throwable) { // java.lang.IllegalStateException: Couldn't read row xxx column yyy eu.faircode.email.Log.e(ex); invalid.set(true); } finally { // release compute lock computing.set(false) } } // check invalid after releasing compute lock to avoid the following scenario. // Thread A runs compute() // Thread A checks invalid, it is false // Main thread sets invalid to true // Thread B runs, fails to acquire compute lock and skips // Thread A releases compute lock // We've left invalid in set state. The check below recovers. } while (computed && invalid.get()) } // invalidation check always happens on the main thread @JvmField @VisibleForTesting internal val invalidationRunnable = Runnable { val isActive = liveData.hasActiveObservers() if (invalid.compareAndSet(false, true)) { if (isActive) { executor.execute(refreshRunnable) } } } /** * Invalidates the LiveData. * * When there are active observers, this will trigger a call to [.compute]. */ open fun invalidate() { ArchTaskExecutor.getInstance().executeOnMainThread(invalidationRunnable) } // TODO https://issuetracker.google.com/issues/112197238 @WorkerThread protected abstract fun compute(): T }