kotlinx-rpc-krpc-ktor-client/kotlinx.rpc.krpc.ktor.client

Package-level declarations

Types

Link copied to clipboard
abstract class KtorRpcClient : KrpcClient

RpcClient implementation for Ktor, containing webSocketSession object, that is used to maintain connection.

Properties

Link copied to clipboard
val Krpc: ClientPlugin<KrpcConfigBuilder.Client>

Ktor client plugin that allows to configure RPC globally for all instances obtained via rpc functions.

Functions

Link copied to clipboard
fun HttpClientConfig<*>.installKrpc(configure: KrpcConfigBuilder.Client.() -> Unit = {})

Installs WebSockets and Krpc client plugins

Link copied to clipboard
fun HttpClient.rpc(block: HttpRequestBuilder.() -> Unit = {}): KtorRpcClient
fun HttpClient.rpc(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): KtorRpcClient

Configures KtorRpcClient for the following path. Provides means for additional configuration via block. Note that the WebSockets plugin is required for these calls.

Link copied to clipboard
fun HttpRequestBuilder.rpcConfig(configBuilder: KrpcConfigBuilder.Client.() -> Unit = {})

Extension function for the HttpRequestBuilder that allows to configure RPC for the call. Usually used with the rpc functions. Overrides Krpc plugin configuration.