Internal API for custom waiting loops

To be used by kotlinx-io

Author: elizarov

common/kotlinx-coroutines-core-common/src/EventLoop.common.kt

@@ -129,3 +129,25 @@ internal object ThreadLocalEventLoop {
 
 internal expect fun createEventLoop(): EventLoop
 
+/**
+ * Processes next event in the current thread's event loop.
+ *
+ * The result of this function is to be interpreted like this:
+ * * `<= 0` -- there are potentially more events for immediate processing;
+ * * `> 0` -- a number of nanoseconds to wait for the next scheduled event;
+ * * [Long.MAX_VALUE] -- no more events, or was invoked from the wrong thread.
+ *
+ * Sample usage of this function:
+ *
+ * ```
+ * while (waitingCondition) {
+ *     val time = processNextEventInCurrentThread()
+ *     LockSupport.parkNanos(time)
+ * }
+ * ```
+ *
+ * @suppress **This an internal API and should not be used from general code.**
+ */
+@InternalCoroutinesApi
+public fun processNextEventInCurrentThread(): Long =
+    ThreadLocalEventLoop.currentOrNull()?.processNextEvent() ?: Long.MAX_VALUE