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

WebSocketTransport
Link copied to clipboard
fun WebSocketTransport(url: URL, okHttpClient: OkHttpClient)
: URL to connect to

Functions

connect
Link copied to clipboard
open override fun connect()
Connect to the server
disconnect
Link copied to clipboard
open override fun disconnect(code: Int, reason: String?)
Disconnect from the Server
onClosed
Link copied to clipboard
open override fun onClosed(webSocket: WebSocket, code: Int, reason: String)
onClosing
Link copied to clipboard
open override fun onClosing(webSocket: WebSocket, code: Int, reason: String)
onFailure
Link copied to clipboard
open override fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?)
onMessage
Link copied to clipboard
open fun onMessage(p0: WebSocket, p1: ByteString)
open override fun onMessage(webSocket: WebSocket, text: String)
onOpen
Link copied to clipboard
open override fun onOpen(webSocket: WebSocket, response: Response)
send
Link copied to clipboard
open override fun send(data: String)
Sends text to the Server

Properties

onClose
Link copied to clipboard
open override var onClose: (Int) -> Unit? = null
Called when the Transport closes
onError
Link copied to clipboard
open override var onError: (Throwable, Response?) -> Unit? = null
Called when the Transport receives an error
onMessage
Link copied to clipboard
open override var onMessage: (String) -> Unit? = null
Called each time the Transport receives a message
onOpen
Link copied to clipboard
open override var onOpen: () -> Unit? = null
Called when the Transport opens
readyState
Link copied to clipboard
open override var readyState: Transport.ReadyState
The state of the Transport.