data class Message(val joinRef: String? = null, val ref: String = "", val topic: String = "", val event: String = "", rawPayload: Payload = HashMap(), val payloadJson: String = "")

OnJoin

typealias OnJoin = (key: String, current: PresenceMap?, new: PresenceMap) -> Unit

Closure signature of OnJoin callbacks

OnLeave

typealias OnLeave = (key: String, current: PresenceMap, left: PresenceMap) -> Unit

Closure signature for OnLeave callbacks

OnSync

typealias OnSync = () -> Unit

Closure signature for OnSync callbacks

Payload

typealias Payload = Map<String, Any?>

Alias for a JSON mapping

PayloadClosure

typealias PayloadClosure = () -> Payload

A closure that will return an optional Payload

Presence

class Presence(channel: Channel, opts: Presence.Options = Options.defaults)

PresenceDiff

typealias PresenceDiff = MutableMap<String, PresenceState>

Diff has keys "joins" and "leaves", pointing to a Presence.State each containing the users that joined and left.

PresenceMap

typealias PresenceMap = MutableMap<String, List<PresenceMeta>>

A mapping of a String to an array of Metas. e.g. {"metas": {id: 1}}

PresenceMeta

typealias PresenceMeta = Map<String, Any>

Meta details of a Presence. Just a dictionary of properties

PresenceState

typealias PresenceState = MutableMap<String, PresenceMap>

A mapping of a Presence state to a mapping of Metas

Push

class Push(val channel: Channel, val event: String, var payloadClosure: PayloadClosure, var timeout: Long = Defaults.TIMEOUT)

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

ScheduledDispatchQueue

class ScheduledDispatchQueue(poolSize: Int = 8) : DispatchQueue

A DispatchQueue that uses a ScheduledThreadPoolExecutor to schedule tasks to be executed in the future.

ScheduledDispatchWorkItem

class ScheduledDispatchWorkItem(scheduledFuture: ScheduledFuture<*>) : DispatchWorkItem

A DispatchWorkItem that wraps a ScheduledFuture<*> created by a ScheduledDispatchQueue

Socket

class Socket(url: String, val paramsClosure: PayloadClosure, val vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, client: OkHttpClient = OkHttpClient.Builder().build())

A Socket which connects to a Phoenix Server. Takes a closure to allow for changing parameters to be sent to the server when connecting.

TimeoutTimer

class TimeoutTimer(dispatchQueue: DispatchQueue, callback: () -> Unit, timerCalculation: (tries: Int) -> Long)

A Timer class that schedules a callback to be called in the future. Can be configured to use a custom retry pattern, such as exponential backoff.

Transport

interface Transport

Interface that defines different types of Transport layers. A default {@link WebSocketTransport} is provided which uses an OkHttp WebSocket to transport data between your Phoenix server.

WebSocketTransport

class WebSocketTransport(url: URL, okHttpClient: OkHttpClient) : WebSocketListener, Transport

A WebSocket implementation of a Transport that uses a WebSocket to facilitate sending and receiving data.

Properties

WS_CLOSE_ABNORMAL

const val WS_CLOSE_ABNORMAL: Int = 1006

RFC 6455: indicates that the connection was closed abnormally

WS_CLOSE_NORMAL

const val WS_CLOSE_NORMAL: Int = 1000

RFC 6455: indicates a normal closure