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

SocketCommon

abstract class SocketCommon(params: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, 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.

connect

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.

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.

endpointUrl

abstract var endpointUrl: URL

The fully qualified socket URL

isConnected

val isConnected: Boolean

logger

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

The optional function to receive logs

protocol

abstract 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

timeout

var timeout: Long

Timeout to use when opening a connection

Inheritors

Socket