interface AffinityExecutor : Executor
An extended executor interface that supports thread affinity assertions and short circuiting. This can be useful for ensuring code runs on the right thread, and also for unit testing.
Gate |
class Gate : AffinityExecutor
An executor useful for unit tests: allows the current thread to block until a command arrives from another thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping. |
ServiceAffinityExecutor |
open class ServiceAffinityExecutor : AffinityExecutor, ThreadPoolExecutor
An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule tasks in the future and verify code is running on the executor. |
isOnThread |
abstract val isOnThread: Boolean
Returns true if the current thread is equal to the thread this executor is backed by. |
checkOnThread |
open fun checkOnThread(): Unit
Throws an IllegalStateException if the current thread is not one of the threads this executor is backed by. |
executeASAP |
open fun executeASAP(runnable: () -> Unit): Unit
If isOnThread() then runnable is invoked immediately, otherwise the closure is queued onto the backing thread. |
fetchFrom |
open fun <T> fetchFrom(fetcher: () -> T): T
Runs the given function on the executor, blocking until the result is available. Be careful not to deadlock this way! Make sure the executor can't possibly be waiting for the calling thread. |
flush |
abstract fun flush(): Unit
Run the executor until there are no tasks pending and none executing. |
Gate |
class Gate : AffinityExecutor
An executor useful for unit tests: allows the current thread to block until a command arrives from another thread, which is then executed. Inbound closures/commands stack up until they are cleared by looping. |
ServiceAffinityExecutor |
open class ServiceAffinityExecutor : AffinityExecutor, ThreadPoolExecutor
An executor backed by thread pool (which may often have a single thread) which makes it easy to schedule tasks in the future and verify code is running on the executor. |