kotlinx-rpc-grpc-client/kotlinx.rpc.grpc.client/GrpcClientConfiguration

GrpcClientConfiguration

Available in a dev version: 0․11․0-grpc-186

How to configure

Configuration class for a gRPC client, providing customization options for client behavior, including interceptors, credentials, marshaller resolution, and authority overrides.

Types

KeepAlive

class KeepAlive

Represents keep-alive settings for a gRPC client connection.

Properties

credentials

var credentials: GrpcClientCredentials?

Configures the client credentials used for secure gRPC requests made by the client.

marshallerConfig

var marshallerConfig: GrpcMarshallerConfig?

messageMarshallerResolver

var messageMarshallerResolver: GrpcMarshallerResolver

Configurable resolver used to determine the appropriate marshaller for a given Kotlin type during message serialization and deserialization in gRPC calls.

overrideAuthority

var overrideAuthority: String?

Overrides the authority used with TLS and HTTP virtual hosting. It does not change what the host is actually connected to. Is commonly in the form host:port.

Functions

intercept

fun intercept(vararg interceptors: GrpcClientInterceptor)

Adds one or more client-side interceptors to the current gRPC client configuration. Interceptors enable extended customization of gRPC calls by observing or altering the behaviors of requests and responses.

keepAlive

fun keepAlive(configure: GrpcClientConfiguration.KeepAlive.() -> Unit)

Configures keep-alive settings for the gRPC client.

plaintext

fun plaintext(): GrpcClientCredentials

Provides insecure client credentials for the gRPC client configuration.

tls

fun tls(configure: GrpcTlsClientCredentialsBuilder.() -> Unit): GrpcClientCredentials

Configures and creates secure client credentials for the gRPC client.