Session

open class Session(webSocket: WebSocket)

Session represents a session via websocket after connection was successful. Within a Session you can bidirectional exchange data with the remote endpoint.

Constructors

Session

fun Session(webSocket: WebSocket)

Functions

suspend fun close(code: Short = 1000, reason: String = "")

closes the current open Session.

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

send

suspend fun send(message: String)

sends a new message to the remote endpoint

suspend fun send(message: ArrayBuffer)

sends a new message to the remote endpoint

suspend fun send(message: ArrayBufferView)

sends a new message to the remote endpoint

suspend fun send(message: Blob)

sends a new message to the remote endpoint

toString

open fun toString(): String

Properties

errors

val errors: Flow<Event>

gives a Flow of error Event when they get fired

messages

val messages: Flow<MessageEvent>

gives a Flow of MessageEvent when the remote endpoint sends them

state

val state: MutableStateFlow<SessionState>

gives the actual SessionState as Flow.

Extensions

closes

val Session.closes: Flow<CloseEvent>

gives a Flow of CloseEvent when Session closes

isClosed

val Session.isClosed: Flow<Boolean>

gives a Flow of Boolean when SessionState is SessionState.Closed

isConnecting

val Session.isConnecting: Flow<Boolean>

gives a Flow of Boolean when SessionState is SessionState.Connecting

isOpen

val Session.isOpen: Flow<Boolean>

gives a Flow of Boolean when SessionState is SessionState.Open

opens

val Session.opens: Flow<Event>

gives a Flow of Event when Session opens