kotlinphoenix-client/io.github.ajacquierbret.kotlinphoenix.client/Socket

Socket

actual class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope) : SocketCommon

expect class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope) : SocketCommon

A Socket which connects to a Phoenix Socket. 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) })

actual class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope) : SocketCommon

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

Constructors

Socket

actual fun Socket(url: String, params: Payload?, vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, scope: CoroutineScope)

expect fun Socket(url: String, params: Payload?, vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, scope: CoroutineScope)

actual fun Socket(url: String, params: Payload?, vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, scope: CoroutineScope)

Socket

actual fun Socket(url: String, paramsClosure: PayloadClosure, vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, scope: CoroutineScope)

expect fun Socket(url: String, paramsClosure: PayloadClosure, vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, scope: CoroutineScope)

actual fun Socket(url: String, paramsClosure: PayloadClosure, vsn: String = Defaults.VSN, encode: EncodeClosure = Defaults.encode, decode: DecodeClosure = Defaults.decode, scope: CoroutineScope)

Functions

channel

fun channel(topic: String, socket: SocketFlow, params: Payload = emptyMap()): Channel

Creates an instance of Channel bound to the specified topic and Socket, taking optional parameters.

fun channel(topic: String, socket: SocketFlow, params: Payload = emptyMap()): Channel

Creates an instance of Channel bound to the specified topic and Socket, taking optional parameters.

fun channel(topic: String, socket: SocketFlow, params: Payload = emptyMap()): Channel

Creates an instance of Channel bound to the specified topic and Socket, taking optional parameters.

connect

suspend fun connect(): SocketFlow?

Connects to the Phoenix Socket. Suspends until the server acknowledges the connection.

suspend fun connect(): SocketFlow?

Connects to the Phoenix Socket. Suspends until the server acknowledges the connection.

suspend fun connect(): SocketFlow?

Connects to the Phoenix Socket. Suspends until the server acknowledges the connection.

disconnect

fun disconnect(code: Int = WS_CLOSE_NORMAL, reason: String? = null)

Disconnects from the Phoenix Socket and resets the reconnectTimer.

fun disconnect(code: Int = WS_CLOSE_NORMAL, reason: String? = null)

Disconnects from the Phoenix Socket and resets the reconnectTimer.

fun disconnect(code: Int = WS_CLOSE_NORMAL, reason: String? = null)

Disconnects from the Phoenix Socket and resets the reconnectTimer.

remove

fun remove(channel: Channel)

Properties

endpoint

abstract var endpoint: String

The string WebSocket endpoint (ie "ws://example.com/socket", "wss://example.com", etc.) that was passed to the Socket during initialization. The URL endpoint will be modified by the Socket to include "/websocket" if missing.