kvision-server-vertx/io.kvision.remote

Package-level declarations

A set of components for creating multiplatform automatic JSON-RPC connectivity with a backend server.

Types

KVServiceManager

expect open class KVServiceManager<out T : Any>(serviceClass: KClass<T>)

Multiplatform service manager.

RequestHandler

typealias RequestHandler = (<Error class: unknown class>) -> Unit

SseHandler

typealias SseHandler = RequestHandler

WebsocketHandler

typealias WebsocketHandler = (<Error class: unknown class>, <Error class: unknown class>) -> Unit

Properties

KV_INJECTOR_KEY

const val KV_INJECTOR_KEY: String

Functions

applyRoutes

fun <T : Any> <Error class: unknown class>.applyRoutes(router: <Error class: unknown class>, serviceManager: KVServiceManager<T>, serializersModules: List<<Error class: unknown class>>? = null)

A function to generate routes based on definitions from the service manager.

getAllServiceManagers

fun getAllServiceManagers(): List<KVServiceManager<*>>

This will make IntelliJ think that this function exists. The real implementation will be generated by the KVision Gradle Plugin.

getServiceManager

inline fun <T : Any> getServiceManager(): KVServiceManager<T>

This will make IntelliJ think that this function exists. The real implementation will be generated by the KVision Gradle Plugin.

getServiceManagers

fun getServiceManagers(vararg kclass: KClass<*>): List<KVServiceManager<*>>

This will make IntelliJ think that this function exists. The real implementation will be generated by the KVision Gradle Plugin.

initStaticResources

fun <Error class: unknown class>.initStaticResources()

Initialize default static resources for Vert.x server.

kvisionInit

fun <Error class: unknown class>.kvisionInit(router: <Error class: unknown class>, vararg modules: Module): <Error class: unknown class>

fun <Error class: unknown class>.kvisionInit(initStaticResources: Boolean = true, router: <Error class: unknown class>, vararg modules: Module): <Error class: unknown class>

Initialization function for Vert.x server.

fun <Error class: unknown class>.kvisionInit(router: <Error class: unknown class>, server: <Error class: unknown class>, wsServiceManagers: List<KVServiceManager<*>> = emptyList(), serializersModules: List<<Error class: unknown class>>? = null, vararg modules: Module): <Error class: unknown class>

fun <Error class: unknown class>.kvisionInit(initStaticResources: Boolean = true, router: <Error class: unknown class>, server: <Error class: unknown class>, wsServiceManagers: List<KVServiceManager<*>> = emptyList(), serializersModules: List<<Error class: unknown class>>? = null, vararg modules: Module): <Error class: unknown class>

Initialization function for Vert.x server with support for WebSockets.

serviceRoute

fun <Error class: unknown class>.serviceRoute(service: KVServiceManager<*>, handler: <Error class: unknown class><<Error class: unknown class>>)