kotlinx-rpc-krpc-ktor-server/kotlinx.rpc.krpc.ktor.server

Package-level declarations

Types

Link copied to clipboard
class KrpcRoute(webSocketSession: DefaultWebSocketServerSession) : DefaultWebSocketServerSession

KrpcRoute class represents an RPC server mounted in Ktor routing. This class provides an API to register services and optionally setup configuration.

Properties

Link copied to clipboard
val Krpc: ApplicationPlugin<KrpcConfigBuilder.Server>

Ktor server plugin that allows to configure RPC globally for all mounted servers.

Functions

Link copied to clipboard
fun Route.rpc(builder: suspend KrpcRoute.() -> Unit)
fun Route.rpc(path: String, builder: suspend KrpcRoute.() -> Unit)

Adds an RPC route to the specified Route. Provides builder to configure kotlinx.rpc.RpcServer that will be used internally. Note that the WebSockets plugin is required for such a route to work.