JavaPhoenixClient/org.phoenixframework/Socket

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.

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

constructor(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. Takes a constant parameter to be sent to the server when connecting. Defaults to null if excluded.

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

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. The URL endpoint will be modified by the Socket to include "/websocket" if missing.

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?

The optional function to receive logs

paramsClosure