ktor-websockets / io.ktor.websocket

Package io.ktor.websocket

Types

DefaultWebSocketServerSession

interface DefaultWebSocketServerSession : DefaultWebSocketSession, WebSocketServerSession

Represents a server-side web socket session with all default implementations

WebSocketServerSession

interface WebSocketServerSession : WebSocketSession

Represents a server-side web socket session

WebSocketUpgrade

class WebSocketUpgrade : ProtocolUpgrade

An OutgoingContent response object that could be used to respond(): it will cause application engine to perform HTTP upgrade and start websocket RAW session.

WebSockets

class WebSockets : CoroutineScope

WebSockets support feature. It is required to be installed first before binding any websocket endpoints

Extensions for External Classes

io.ktor.routing.Route

kotlinx.coroutines.CoroutineScope

Properties

application

val WebSocketServerSession.application: Application

An application that started this web socket session

Functions

WebSockets

fun WebSockets(pingInterval: <ERROR CLASS>?, timeout: <ERROR CLASS>, maxFrameSize: Long, masking: Boolean): WebSockets