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

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

Multiplatform service manager.

actual open class KVServiceManager<out T : Any>(serviceClass: KClass<T>) : KVServiceManagerJs<T> , KVServiceMgr<T>

Multiplatform service manager.

actual open class KVServiceManager<out T : Any>(serviceClass: KClass<T>) : KVServiceBinder<T, RequestHandler, WebsocketHandler, SseHandler> , KVServiceMgr<T>

Multiplatform service manager for Vert.x.

RequestHandler

typealias RequestHandler = (RoutingContext) -> Unit

SseHandler

typealias SseHandler = RequestHandler

WebsocketHandler

typealias WebsocketHandler = (Injector, ServerWebSocket) -> Unit

Properties

KV_INJECTOR_KEY

const val KV_INJECTOR_KEY: String

Functions

applyRoutes

fun <T : Any> Vertx.applyRoutes(router: Router, serviceManager: KVServiceManager<T>, serializersModules: List<SerializersModule>? = 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 Router.initStaticResources()

Initialize default static resources for Vert.x server.

kvisionInit

fun Vertx.kvisionInit(router: Router, vararg modules: Module): Injector

fun Vertx.kvisionInit(initStaticResources: Boolean = true, router: Router, vararg modules: Module): Injector

Initialization function for Vert.x server.

fun Vertx.kvisionInit(router: Router, server: HttpServer, wsServiceManagers: List<KVServiceManager<*>> = emptyList(), serializersModules: List<SerializersModule>? = null, vararg modules: Module): Injector

fun Vertx.kvisionInit(initStaticResources: Boolean = true, router: Router, server: HttpServer, wsServiceManagers: List<KVServiceManager<*>> = emptyList(), serializersModules: List<SerializersModule>? = null, vararg modules: Module): Injector

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

serviceRoute

fun Router.serviceRoute(service: KVServiceManager<*>, handler: Handler<RoutingContext>)