JavaPhoenixClient/org.phoenixframework/Channel

Channel

class Channel(val topic: String, paramsClosure: PayloadClosure, socket: Socket)

Represents a Channel bound to a given topic

Constructors

constructor(topic: String, params: Payload, socket: Socket)

constructor(topic: String, paramsClosure: PayloadClosure, socket: Socket)

Types

enum Event : Enum<Channel.Event>

Channel specific events

enum State : Enum<Channel.State>

States of a Channel

Properties

val canPush: Boolean

val isClosed: Boolean

val isErrored: Boolean

val isJoined: Boolean

val isJoining: Boolean

val isLeaving: Boolean

val joinRef: String?

The ref sent during the join message.

var params: Payload

Params passed in through constructions and provided to the JoinPush

val topic: String

Functions

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

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

fun off(event: String, ref: Int? = null)

fun on(event: String, callback: (Message) -> Unit): Int

fun on(event: Channel.Event, callback: (Message) -> Unit): Int

fun onClose(callback: (Message) -> Unit): Int

fun onError(callback: (Message) -> Unit): Int

fun onMessage(callback: (Message) -> Message)

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