core/dev.fritz2.remote/Session

Session

open class Session(webSocket: WebSocket)

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

Constructors

Session

constructor(webSocket: WebSocket)

Properties

closes

val Session.closes: Flow<CloseEvent>

gives a Flow of CloseEvent when Session closes

errors

val errors: Flow<Event>

gives a Flow of error Event when they get fired

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

messages

val messages: Flow<MessageEvent>

gives a Flow of MessageEvent when the remote endpoint sends them

opens

val Session.opens: Flow<Event>

gives a Flow of Event when Session opens

state

val state: MutableStateFlow<SessionState>

gives the actual SessionState as Flow.

Functions

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

closes the current open Session.

send

suspend fun send(message: String)

suspend fun send(message: ArrayBuffer)

suspend fun send(message: ArrayBufferView)

suspend fun send(message: Blob)

sends a new message to the remote endpoint