receive(), called on a channel, will suspend until there is an object available, then returns that object.

There is a similar receiveOrNull() function that also suspends until an object is available, then returns that object. The difference is what happens if the channel is closed while receive() or receiveOrNull() is suspended:

  • receive() throws a ClosedReceiveChannelException

  • receiveOrNull() returns null (which might be confusing if null is a valid object to appear in the channel)

You can learn more about this in:
Tags:
A Conflated Channel A Fixed-Buffer Channel A Simple Channel A Zero-Buffer Channel BroadcastChannel Channel and receive() Channels and Fan-out Hot Channels Via offer() The Channel() Function toList() for Channel
A Conflated Channel A Fixed-Buffer Channel A Parallel Coroutine Sample A Sequential Coroutine Sample A Simple Channel A Simple Coroutine Sample A Simple Flow A Simple SharedFlow A Simple StateFlow A Zero-Buffer Channel async() BroadcastChannel cancelAndJoin() Canceling a Job Canceling a Parent Cancels Its Children Canceling and Cooperation catch() Channel and receive() Channels and Fan-out combine() Operator Contexts and Jobs Cooperation by Checking isActive Cooperation by Yielding debounce() Operator distinctUntilChanged() Operator distinctUntilChangedBy() Operator drop() Operator dropWhile() Operator filter() Operator filterIsInstance() Operator filterNot() Operator filterNotNull() Operator first() and Flow flattenConcat() Operator flattenMerge() Operator Flow Actions Flow onStart() flowOf() flowOn() Flows and Exceptions fold() Operator Hot Channels Via offer() invokeOnCompletion() Jobs and Parents Jobs Cancel When They Crash join() Lazy Coroutines map() Operator mapLatest() Operator mapNotNull() Operator Massively Parallel Coroutines MutableSharedFlow Replay Option Non-Cancellable Coroutines Parent Jobs Cancel When a Child Crashes promise() retry() retryWhen() runBlocking() sample() Operator scan() Operator single() and singleOrNull() Starting Lazy Coroutines StateFlow and Content Equality suspend Functions and Flows Suspending main() take() Operator takeWhile() Operator The Channel() Function TimeoutCancellationException Timeouts toList() and toSet() toList() for Channel withIndex() Operator withTimeoutOrNull() zip() Operator
Run Edit