Transport

interface Transport

Interface that defines different types of Transport layers. A default {@link WebSocketTransport} is provided which uses an OkHttp WebSocket to transport data between your Phoenix server.

Future support may be added to provide your own custom Transport, such as a LongPoll

Types

ReadyState

enum ReadyState : Enum<Transport.ReadyState>

Available ReadyStates of a {@link Transport}.

Functions

connect

abstract fun connect()

Connect to the server

disconnect

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

Disconnect from the Server

send

abstract fun send(data: String)

Sends text to the Server

Properties

onClose

abstract var onClose: (Int) -> Unit?

Called when the Transport closes

onError

abstract var onError: (Throwable, Response?) -> Unit?

Called when the Transport receives an error

onMessage

abstract var onMessage: (String) -> Unit?

Called each time the Transport receives a message

onOpen

abstract var onOpen: () -> Unit?

Called when the Transport opens

readyState

abstract val readyState: Transport.ReadyState

The state of the Transport.

Inheritors

WebSocketTransport