Socket

class Socket(url: String, params: Payload?, gson: Gson, client: OkHttpClient)

Connects to a Phoenix Server

Constructors

Socket

fun Socket(url: String, params: Payload? = null, gson: Gson = Defaults.gson, client: OkHttpClient = OkHttpClient.Builder().build())

Functions

channel

fun channel(topic: String, params: Payload = mapOf()): Channel

connect

fun connect()

disconnect

fun disconnect(code: Int = WS_CLOSE_NORMAL, reason: String? = null, callback: () -> Unit? = null)

logItems

fun logItems(body: String)

off

fun off(refs: List<String>)

Removes onOpen, onClose, onError, and onMessage registrations by their ref value.

onClose

fun onClose(callback: () -> Unit): String

onError

fun onError(callback: (Throwable, Response?) -> Unit): String

onMessage

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

onOpen

fun onOpen(callback: () -> Unit): String

remove

fun remove(channel: Channel)

removeAllCallbacks

fun removeAllCallbacks()

Properties

endpoint

val endpoint: String

The string WebSocket endpoint (ie "ws://example.com/socket", "wss://example.com", etc.) that was passed to the Socket during initialization.

endpointUrl

val endpointUrl: URL

The fully qualified socket URL

heartbeatIntervalMs

var heartbeatIntervalMs: Long

Interval between sending a heartbeat, in ms

isConnected

val isConnected: Boolean

logger

var logger: (String) -> Unit? = null

The optional function to receive logs

params

val params: Payload?

The optional params to pass when connecting.

protocol

val protocol: String

reconnectAfterMs

var reconnectAfterMs: (Int) -> Long

Interval between socket reconnect attempts, in ms

rejoinAfterMs

var rejoinAfterMs: (Int) -> Long

Interval between channel rejoin attempts, in ms

skipHeartbeat

var skipHeartbeat: Boolean = false

Disables heartbeats from being sent.

timeout

var timeout: Long

Timeout to use when opening a connection