Push

class Push(channel: Channel, event: String, payload: Payload, timeout: Long, scope: CoroutineScope) : SharedFlow<Message>

A Push represents an attempt to send a payload through a Channel for a specific event.

Constructors

fun Push(channel: Channel, event: String, payload: Payload = emptyMap(), timeout: Long = Defaults.TIMEOUT, scope: CoroutineScope)

open suspend override fun collect(collector: FlowCollector<Message>): Nothing

suspend fun emit(value: Message)

suspend fun resend(timeout: Long = Defaults.TIMEOUT)

Resets and sends the Push

suspend fun send()

Sends the Push. If it has already timed out then the call will be ignored. use resend(timeout:) in this case.

The channel the Push is being sent through

The event the Push is targeting

The message to be sent

Duration before the message is considered timed out and failed to send