ktor-websockets

alltypes

interface DefaultWebSocketServerSession : DefaultWebSocketSession, WebSocketServerSession
interface WebSocketServerSession : WebSocketSession

abstract val call: ApplicationCall

class WebSocketUpgrade : ProtocolUpgrade

WebSocketUpgrade(call: ApplicationCall, protocol: String? = null, handle: suspend WebSocketSession.() -> Unit)
WebSocketUpgrade(call: ApplicationCall, protocol: String? = null, installExtensions: Boolean = false, handle: suspend WebSocketSession.() -> Unit)
val call: ApplicationCall
val handle: suspend WebSocketSession.() -> Unit
val headers: Headers
val protocol: String?
suspend fun upgrade(input: ByteReadChannel, output: ByteWriteChannel, engineContext: <ERROR CLASS>, userContext: <ERROR CLASS>): Job

class WebSockets : CoroutineScope

WebSockets(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean)
WebSockets(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean, extensionsConfig: WebSocketExtensionsConfig)
val EXTENSIONS_KEY: AttributeKey<List<WebSocketExtension<*>>>
companion object Feature : ApplicationFeature<Application, WebSocketOptions, WebSockets>

val EXTENSIONS_KEY: AttributeKey<List<WebSocketExtension<*>>>
fun install(pipeline: Application, configure: WebSocketOptions.() -> Unit): WebSockets
val key: AttributeKey<WebSockets>

class WebSocketOptions

WebSocketOptions()
fun extensions(block: WebSocketExtensionsConfig.() -> Unit): Unit
var masking: Boolean
var maxFrameSize: Long
var pingPeriod: Duration?
var pingPeriodMillis: Long
var timeout: Duration
var timeoutMillis: Long

val coroutineContext: <ERROR CLASS>
val extensionsConfig: WebSocketExtensionsConfig
fun install(pipeline: Application, configure: WebSocketOptions.() -> Unit): WebSockets
val key: AttributeKey<WebSockets>
val masking: Boolean
val maxFrameSize: Long
val pingIntervalMillis: Long
val timeoutMillis: Long

io.ktor.routing.Route

fun Route.webSocket(protocol: String? = null, handler: suspend DefaultWebSocketServerSession.() -> Unit): Unit
fun Route.webSocket(webSocketProtocol: String, webSocketHandler: suspend DefaultWebSocketServerSession.() -> Unit, nothing: Nothing? = null): Unit
fun Route.webSocket(path: String, protocol: String? = null, handler: suspend DefaultWebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(path: String, protocol: String? = null, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(path: String, protocol: String? = null, negotiateExtensions: Boolean = false, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(protocol: String? = null, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(protocol: String? = null, negotiateExtensions: Boolean = false, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(webSocketProtocol: String, webSocketHandler: suspend WebSocketServerSession.() -> Unit, nothing: Nothing? = null): Unit

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, period: Duration, timeout: Duration, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, period: <ERROR CLASS>, timeout: <ERROR CLASS>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>

package io.ktor.http.cio.websocket

fun WebSockets(pingInterval: Duration?, timeout: Duration, maxFrameSize: Long, masking: Boolean): WebSockets
kotlinx.coroutines.CoroutineScope

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, period: Duration, timeout: Duration, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>

inline var DefaultWebSocketServerSession.pingInterval: Duration?
inline val WebSockets.pingInterval: Duration?
inline var WebSocketOptions.pingPeriod: Duration?
inline var DefaultWebSocketServerSession.timeout: Duration
inline val WebSockets.timeout: Duration
inline var WebSocketOptions.timeout: Duration

package io.ktor.websocket

interface DefaultWebSocketServerSession : DefaultWebSocketSession, WebSocketServerSession
interface WebSocketServerSession : WebSocketSession

abstract val call: ApplicationCall

class WebSocketUpgrade : ProtocolUpgrade

WebSocketUpgrade(call: ApplicationCall, protocol: String? = null, handle: suspend WebSocketSession.() -> Unit)
WebSocketUpgrade(call: ApplicationCall, protocol: String? = null, installExtensions: Boolean = false, handle: suspend WebSocketSession.() -> Unit)
val call: ApplicationCall
val handle: suspend WebSocketSession.() -> Unit
val headers: Headers
val protocol: String?
suspend fun upgrade(input: ByteReadChannel, output: ByteWriteChannel, engineContext: <ERROR CLASS>, userContext: <ERROR CLASS>): Job

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

WebSockets(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean)
WebSockets(pingIntervalMillis: Long, timeoutMillis: Long, maxFrameSize: Long, masking: Boolean, extensionsConfig: WebSocketExtensionsConfig)
val EXTENSIONS_KEY: AttributeKey<List<WebSocketExtension<*>>>
companion object Feature : ApplicationFeature<Application, WebSocketOptions, WebSockets>

val EXTENSIONS_KEY: AttributeKey<List<WebSocketExtension<*>>>
fun install(pipeline: Application, configure: WebSocketOptions.() -> Unit): WebSockets
val key: AttributeKey<WebSockets>

class WebSocketOptions

WebSocketOptions()
fun extensions(block: WebSocketExtensionsConfig.() -> Unit): Unit
var masking: Boolean
var maxFrameSize: Long
var pingPeriod: Duration?
var pingPeriodMillis: Long
var timeout: Duration
var timeoutMillis: Long

val coroutineContext: <ERROR CLASS>
val extensionsConfig: WebSocketExtensionsConfig
fun install(pipeline: Application, configure: WebSocketOptions.() -> Unit): WebSockets
val key: AttributeKey<WebSockets>
val masking: Boolean
val maxFrameSize: Long
val pingIntervalMillis: Long
val timeoutMillis: Long

val WebSocketServerSession.application: Application
io.ktor.routing.Route

fun Route.webSocket(protocol: String? = null, handler: suspend DefaultWebSocketServerSession.() -> Unit): Unit
fun Route.webSocket(webSocketProtocol: String, webSocketHandler: suspend DefaultWebSocketServerSession.() -> Unit, nothing: Nothing? = null): Unit
fun Route.webSocket(path: String, protocol: String? = null, handler: suspend DefaultWebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(path: String, protocol: String? = null, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(path: String, protocol: String? = null, negotiateExtensions: Boolean = false, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(protocol: String? = null, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(protocol: String? = null, negotiateExtensions: Boolean = false, handler: suspend WebSocketServerSession.() -> Unit): Unit
fun Route.webSocketRaw(webSocketProtocol: String, webSocketHandler: suspend WebSocketServerSession.() -> Unit, nothing: Nothing? = null): Unit

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, period: <ERROR CLASS>, timeout: <ERROR CLASS>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>