streampack-core/io.github.thibaultbee.streampack.core.elements.utils/ChannelWithCloseableData

ChannelWithCloseableData

class ChannelWithCloseableData<T>(capacity: Int = RENDEZVOUS, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND) : ReceiveChannel<ChannelWithCloseableData.CloseableData<T>> (source)

A channel that sends and receives data along with a close action to be executed when the data is no longer needed.

Parameters

The type of data to be sent and received.

capacity

The capacity of the channel.

onBufferOverflow

The behavior when the buffer overflows.

Constructors

ChannelWithCloseableData

constructor(capacity: Int = RENDEZVOUS, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND)

Types

CloseableData

class CloseableData<T>(val data: T, val onClose: () -> Unit) : Closeable

Properties

isClosedForReceive

@DelicateCoroutinesApi

open override val isClosedForReceive: Boolean

isEmpty

@ExperimentalCoroutinesApi

open override val isEmpty: Boolean

onReceive

open override val onReceive: SelectClause1<ChannelWithCloseableData.CloseableData<T>>

onReceiveCatching

open override val onReceiveCatching: SelectClause1<ChannelResult<ChannelWithCloseableData.CloseableData<T>>>

onReceiveOrNull

open val ~~onReceiveOrNull~~: SelectClause1<ChannelWithCloseableData.CloseableData<T>?>

Functions

cancel

open override fun cancel(cause: CancellationException?)

iterator

open operator override fun iterator(): ChannelIterator<ChannelWithCloseableData.CloseableData<T>>

poll

open fun ~~poll~~(): ChannelWithCloseableData.CloseableData<T>?

receive

open suspend override fun receive(): ChannelWithCloseableData.CloseableData<T>

Receives data along with its close action from the channel.

receiveCatching

open suspend override fun receiveCatching(): ChannelResult<ChannelWithCloseableData.CloseableData<T>>

receiveOrNull

open suspend fun ~~receiveOrNull~~(): ChannelWithCloseableData.CloseableData<T>?

send

suspend fun send(data: T, onClose: () -> Unit = {})

Sends data along with a close action to the channel.

tryReceive

open override fun tryReceive(): ChannelResult<ChannelWithCloseableData.CloseableData<T>>

useConsumeEach

inline suspend fun <T> ChannelWithCloseableData<T>.useConsumeEach(action: (T) -> Unit)

useReceive

inline suspend fun <T, R> ChannelWithCloseableData<T>.useReceive(block: (T) -> R): R

Receives data from the channel and uses it in a block, ensuring that the data is properly closed after use.