Kweb

Constructors

constructor(port: Int, debug: Boolean = true, plugins: List<KwebPlugin> = Collections.emptyList(), httpsConfig: EngineSSLConnectorConfig? = null, kwebConfig: KwebConfiguration = KwebDefaultConfiguration(), buildPage: WebBrowser.() -> Unit)

The core kwebserver, and the starting point for almost any Kweb app. This will create a HTTP server and respond with a javascript page which will establish a websocket connection to retrieve and send instructions and data between browser and server.

Types

Feature

object Feature : BaseApplicationPlugin<Application, Kweb.Feature.Configuration, Kweb>

If you have an existing Ktor server, you can use the Kweb class as a feature. Adding this to your code is easy:

Properties

clientState

val clientState: Cache<String, RemoteClientState>

The state of "clients", each representing a webbrowser session.

debug

val debug: Boolean

kwebConfig

val kwebConfig: KwebConfiguration

plugins

val plugins: List<KwebPlugin>

Functions

addCallback

fun addCallback(sessionId: String, callbackId: Int, callback: (JsonElement) -> Unit)

callJs

fun callJs(sessionId: String, funcCall: FunctionCall, debugInfo: DebugInfo? = null)

open override fun close()

determineClientPrefix

fun determineClientPrefix(call: ApplicationCall): String

refreshAllPages

fun refreshAllPages()

Forces all currently connected clients to refresh their pages. This can be useful if there has been a code-change, for example.

removeCallback

fun removeCallback(clientId: String, callbackId: Int)

respondKweb

suspend fun respondKweb(call: ApplicationCall, buildPage: WebBrowser.() -> Unit)

sendMessage

fun sendMessage(sessionId: String, server2ClientMessage: Server2ClientMessage)