For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ktor

Ktor is the asynchronous web framework for Kotlin created by JetBrains. It is written in Kotlin and its machinery and API is utilizing Kotlin coroutines. It's unopinionated design makes it a very good choice for development of applications composed of many different technologies.

Build configuration

Kilua RPC provides three different modules for Ktor:

  • kilua-rpc-ktor, which doesn't use dependency injection (DI) and requires manual services registration,

  • kilua-rpc-ktor-koin, which uses Koin dependency injection framework to access services implementations.

  • kilua-rpc-ktor-metro, which uses Metro dependency injection framework to access services implementations.

You need to add one of these modules to your project.

val commonMain by getting {
    dependencies {
        implementation("dev.kilua:kilua-rpc-ktor:$kiluaRpcVersion")
//        implementation("dev.kilua:kilua-rpc-ktor-koin:$kiluaRpcVersion")
//        implementation("dev.kilua:kilua-rpc-ktor-metro:$kiluaRpcVersion")
    }
}

Service implementation

Service class

The implementation of the service class comes down to implementing required interface methods.

When using Metro, you need to add some annotations and the MetroRpcService interface to your service class.

Injecting server objects

You can use constructor parameters to inject server objects - ApplicationCall and WebSocketServerSession (see Websockets chapter) into your service classes. These objects give you access to the application configuration, its state, the current request and the user session (if it is configured).

Blocking code

Since Ktor architecture is asynchronous and non-blocking, you should never block a thread in your application code. If you have to use some blocking code (e.g. blocking I/O, JDBC) always use the dedicated coroutine dispatcher.

Application configuration

The main function

This function is the application starting point. It's used to initialize and configure application modules and features. Minimal implementation for Kilua RPC integration contains applyRoutes function calls and service initialization with an appropriate initRpc function (should be executed as last).

When using manual service registration, you call initRpc with a lambda function, which binds interfaces with their implementations. Different overloads of registerService function allow injecting server objects into your service classes.

When using Koin, you call initRpcKoin to initialize Koin modules. Constructor parameter injection is automatically supported by Koin.

When using Metro, you call initRpcMetro to initialize Metro dependency graph. Constructor parameter injection is automatically supported by Metro.

Security

When using authentication plugin you can choose different security options for different services by calling applyRoutes in different contexts.

Last updated