Skip to content

Allow suspend calls inside ktor rpc builder #433 #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2025
Merged

Allow suspend calls inside ktor rpc builder #433 #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions krpc/krpc-ktor/krpc-ktor-server/api/krpc-ktor-server.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public final class kotlinx/rpc/krpc/ktor/server/KrpcRoute : io/ktor/server/webso
}

public final class kotlinx/rpc/krpc/ktor/server/KtorServerDslKt {
public static final fun rpc (Lio/ktor/server/routing/Route;Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
public static final fun rpc (Lio/ktor/server/routing/Route;Lkotlin/jvm/functions/Function1;)V
public static final fun rpc (Lio/ktor/server/routing/Route;Ljava/lang/String;Lkotlin/jvm/functions/Function2;)V
public static final fun rpc (Lio/ktor/server/routing/Route;Lkotlin/jvm/functions/Function2;)V
}

4 changes: 2 additions & 2 deletions krpc/krpc-ktor/krpc-ktor-server/api/krpc-ktor-server.klib.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ final class kotlinx.rpc.krpc.ktor.server/KrpcRoute : io.ktor.server.websocket/De
final val kotlinx.rpc.krpc.ktor.server/Krpc // kotlinx.rpc.krpc.ktor.server/Krpc|{}Krpc[0]
final fun <get-Krpc>(): io.ktor.server.application/ApplicationPlugin<kotlinx.rpc.krpc/KrpcConfigBuilder.Server> // kotlinx.rpc.krpc.ktor.server/Krpc.<get-Krpc>|<get-Krpc>(){}[0]

final fun (io.ktor.server.routing/Route).kotlinx.rpc.krpc.ktor.server/rpc(kotlin/Function1<kotlinx.rpc.krpc.ktor.server/KrpcRoute, kotlin/Unit>) // kotlinx.rpc.krpc.ktor.server/rpc|rpc@io.ktor.server.routing.Route(kotlin.Function1<kotlinx.rpc.krpc.ktor.server.KrpcRoute,kotlin.Unit>){}[0]
final fun (io.ktor.server.routing/Route).kotlinx.rpc.krpc.ktor.server/rpc(kotlin/String, kotlin/Function1<kotlinx.rpc.krpc.ktor.server/KrpcRoute, kotlin/Unit>) // kotlinx.rpc.krpc.ktor.server/rpc|rpc@io.ktor.server.routing.Route(kotlin.String;kotlin.Function1<kotlinx.rpc.krpc.ktor.server.KrpcRoute,kotlin.Unit>){}[0]
final fun (io.ktor.server.routing/Route).kotlinx.rpc.krpc.ktor.server/rpc(kotlin.coroutines/SuspendFunction1<kotlinx.rpc.krpc.ktor.server/KrpcRoute, kotlin/Unit>) // kotlinx.rpc.krpc.ktor.server/rpc|rpc@io.ktor.server.routing.Route(kotlin.coroutines.SuspendFunction1<kotlinx.rpc.krpc.ktor.server.KrpcRoute,kotlin.Unit>){}[0]
final fun (io.ktor.server.routing/Route).kotlinx.rpc.krpc.ktor.server/rpc(kotlin/String, kotlin.coroutines/SuspendFunction1<kotlinx.rpc.krpc.ktor.server/KrpcRoute, kotlin/Unit>) // kotlinx.rpc.krpc.ktor.server/rpc|rpc@io.ktor.server.routing.Route(kotlin.String;kotlin.coroutines.SuspendFunction1<kotlinx.rpc.krpc.ktor.server.KrpcRoute,kotlin.Unit>){}[0]
11 changes: 7 additions & 4 deletions ...ktor/krpc-ktor-server/src/commonMain/kotlin/kotlinx/rpc/krpc/ktor/server/KtorServerDsl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import kotlinx.rpc.krpc.rpcServerConfig
* @param builder Builder function to configure RPC server.
*/
@KtorDsl
public fun Route.rpc(path: String, builder: KrpcRoute.() -> Unit) {
public fun Route.rpc(path: String, builder: suspend KrpcRoute.() -> Unit) {
route(path) {
rpc(builder)
}
Expand All @@ -34,16 +34,19 @@ public fun Route.rpc(path: String, builder: KrpcRoute.() -> Unit) {
* @param builder Builder function to configure RPC server.
*/
@KtorDsl
public fun Route.rpc(builder: KrpcRoute.() -> Unit) {
public fun Route.rpc(builder: suspend KrpcRoute.() -> Unit) {
createRpcServer(builder)
}

private fun Route.createRpcServer(rpcRouteBuilder: KrpcRoute.() -> Unit) {
private fun Route.createRpcServer(rpcRouteBuilder: suspend KrpcRoute.() -> Unit) {
application.pluginOrNull(WebSockets)
?: error("RPC for server requires $WebSockets plugin to be installed firstly")

webSocket {
val rpcRoute = KrpcRoute(this).apply(rpcRouteBuilder)
val rpcRoute = KrpcRoute(this).apply {
rpcRouteBuilder()
}

val pluginConfigBuilder = application.attributes.getOrNull(KrpcServerPluginAttributesKey)
val rpcConfig = pluginConfigBuilder?.apply(rpcRoute.configBuilder)?.build()
?: rpcServerConfig(rpcRoute.configBuilder)
Expand Down