WebSocketTransport

class WebSocketTransport(url: URL, okHttpClient: OkHttpClient) : WebSocketListener, Transport

A WebSocket implementation of a Transport that uses a WebSocket to facilitate sending and receiving data.

Parameters

url

: URL to connect to

okHttpClient

: Custom client that can be pre-configured before connecting

Constructors

Link copied to clipboard
constructor(url: URL, okHttpClient: OkHttpClient)

Properties

Link copied to clipboard
open override var onClose: (Int) -> Unit?

Called when the Transport closes

Link copied to clipboard
open override var onError: (Throwable, Response?) -> Unit?

Called when the Transport receives an error

Link copied to clipboard
open override var onMessage: (String) -> Unit?

Called each time the Transport receives a message

Link copied to clipboard
open override var onOpen: () -> Unit?

Called when the Transport opens

Link copied to clipboard
open override var readyState: Transport.ReadyState

The state of the Transport. See {@link ReadyState}

Functions

Link copied to clipboard
open override fun connect()

Connect to the server

Link copied to clipboard
open override fun disconnect(code: Int, reason: String?)

Disconnect from the Server

Link copied to clipboard
open override fun onClosed(webSocket: WebSocket, code: Int, reason: String)
Link copied to clipboard
open override fun onClosing(webSocket: WebSocket, code: Int, reason: String)
Link copied to clipboard
open override fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?)
Link copied to clipboard
open fun onMessage(webSocket: WebSocket, bytes: ByteString)
open override fun onMessage(webSocket: WebSocket, text: String)
Link copied to clipboard
open override fun onOpen(webSocket: WebSocket, response: Response)
Link copied to clipboard
open override fun send(data: String)

Sends text to the Server