Channel

class Channel(topic: String, params: Payload, socket: Socket)

Represents a Channel bound to a given topic

Constructors

Channel

fun Channel(topic: String, params: Payload, socket: Socket)

Types

Event

enum Event : Enum<Channel.Event>

Channel specific events

State

enum State : Enum<Channel.State>

States of a Channel

Functions

join

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

leave

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

off

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

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

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

onClose

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

onError

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

onMessage

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

push

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

Properties

canPush

val canPush: Boolean

isClosed

val isClosed: Boolean

isErrored

val isErrored: Boolean

isJoined

val isJoined: Boolean

isJoining

val isJoining: Boolean

isLeaving

val isLeaving: Boolean

joinRef

val joinRef: String?

The ref sent during the join message.

params

var params: Payload

Params passed in through constructions and provided to the JoinPush

topic

val topic: String