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

KrpcRoute

class KrpcRoute(webSocketSession: DefaultWebSocketServerSession) : DefaultWebSocketServerSession(source)

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

Constructors

constructor(webSocketSession: DefaultWebSocketServerSession)

Properties

open override val call: ApplicationCall

open override val closeReason: Deferred<CloseReason?>

coroutineContext

open override val coroutineContext: CoroutineContext

open override val extensions: List<WebSocketExtension<*>>

open override val incoming: ReceiveChannel<Frame>

open override var masking: Boolean

open override var maxFrameSize: Long

open override val outgoing: SendChannel<Frame>

pingIntervalMillis

open override var pingIntervalMillis: Long

open override var timeoutMillis: Long

Functions

open suspend override fun flush()

registerService

inline fun <Service : Any> registerService(noinline serviceFactory: () -> Service)

fun <Service : Any> registerService(serviceKClass: KClass<Service>, serviceFactory: () -> Service)

Registers new service to the server. Server will route all designated messages to it. Service of any type should be unique on the server, but RpcServer does not specify the actual retention policy.

fun rpcConfig(configBuilder: KrpcConfigBuilder.Server.() -> Unit)

Optionally configures the declared RPC server. Overrides Krpc plugin configuration.

open suspend override fun send(frame: Frame)

open override fun start(negotiatedExtensions: List<WebSocketExtension<*>>)

open override fun ~~terminate~~()