Skip to content

Add more documentation about a case where .offer() can throw #1824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add more documentation about a case where .offer() can throw #1824

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
742abb1
Add more documentation about a case where .offer() can throw
martinbonnin Feb 21, 2020
e8acbbe
Update kotlinx-coroutines-core/common/src/flow/Builders.kt
Feb 21, 2020
3d1d63a
Update Builders.kt
Feb 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions kotlinx-coroutines-core/common/src/flow/Builders.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,9 +293,14 @@ public fun <T> channelFlow(@BuilderInference block: suspend ProducerScope<T>.()
* fun flowFrom(api: CallbackBasedApi): Flow<T> = callbackFlow {
* val callback = object : Callback { // implementation of some callback interface
* override fun onNextValue(value: T) {
* // Note: offer drops value when buffer is full
* // Note: offer drops values when the buffer is full
* // Use either buffer(Channel.CONFLATED) or buffer(Channel.UNLIMITED) to avoid overfill
* offer(value)
* // Also, offer will throw if the channel is canceled.
* // To avoid that, we wrap the call in runBlocking.
* // See https://github.com/Kotlin/kotlinx.coroutines/issues/974
* runBlocking {
* offer(value)
* }
* }
* override fun onApiError(cause: Throwable) {
* cancel(CancellationException("API Error", cause))
Expand Down