Channel

class Channel(topic: String, params: Payload, socket: Socket, socketFlow: SocketFlow, scope: CoroutineScope) : SharedFlow<Message>

Represents a Channel bound to a given topic

Constructors

fun Channel(topic: String, params: Payload, socket: Socket, socketFlow: SocketFlow, scope: CoroutineScope)

Channel specific events

States of a Channel

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

suspend fun join(timeout: Long = this.timeout): Push

Tries to join the Phoenix channel with the specified timeout.

suspend fun leave(timeout: Long = this.timeout): Push

Tries to leave the Channel with the specified timeout.

suspend fun push(event: String, payload: Payload, timeout: Long = this.timeout): Push

Tries to send the specified event and payload to bound Channel if it has already been joined.

The ref sent during the joinPush.

Params passed in through constructions and provided to the joinPush