Socket

class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, client: OkHttpClient)

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

Example

val socket = Socket("https://example.com/socket", { mapOf("token" to mAuthToken) })

Parameters

url

Url to connect to such as https://example.com/socket

paramsClosure

Closure which allows to change parameters sent during connection.

vsn

JSON Serializer version to use. Defaults to 2.0.0

encode

Optional. Provide a custom JSON encoding implementation

decode

Optional. Provide a custom JSON decoding implementation

client

Default OkHttpClient to connect with. You can provide your own if needed.

Constructors

Socket

fun Socket(url: String, params: Payload = mapOf(), 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.

Socket

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

Url to connect to such as https://example.

Functions

channel

fun channel(topic: String, paramsClosure: PayloadClosure): Channel

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

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

connectionState

val connectionState: Transport.ReadyState

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

var 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

paramsClosure

val paramsClosure: PayloadClosure

Closure which allows to change parameters sent during connection.

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

vsn

val vsn: String

JSON Serializer version to use.