orbit-client / orbit.client / OrbitClientConfig

OrbitClientConfig

data class OrbitClientConfig

Constructors

<init>

OrbitClientConfig(grpcEndpoint: String = "dns:///localhost:50056/", namespace: String = "default", tickRate: Duration = Duration.ofSeconds(1), pool: CoroutineDispatcher = Pools.createFixedPool("orbit-client"), railCount: Int = 128, bufferCount: Int = 10_000, packages: List<String> = listOf(), messageTimeout: Duration = Duration.ofSeconds(10), deactivationTimeout: Duration = Duration.ofSeconds(10), addressableTTL: Duration = Duration.ofMinutes(10), addressableConstructor: ExternallyConfigured<AddressableConstructor> = DefaultAddressableConstructor.DefaultAddressableConstructorSingleton, networkRetryAttempts: Int = 5, joinClusterTimeout: Duration = Duration.ofSeconds(30), nodeLeaseRenewalFailedHandler: ExternallyConfigured<NodeLeaseRenewalFailedHandler> = RestartOnNodeRenewalFailure.RestartOnNodeRenewalFailureSingleton)

Properties

addressableConstructor

The system to use to construct addressables.

val addressableConstructor: ExternallyConfigured<AddressableConstructor>

addressableTTL

The default TTL for addressables.

val addressableTTL: Duration

bufferCount

The number of messages (inbound) that may be queued before new messages are rejected.

val bufferCount: Int

deactivationTimeout

The default timeout for deactivation.

val deactivationTimeout: Duration

grpcEndpoint

The gRPC endpoint where the Orbit cluster is located.

val grpcEndpoint: String

joinClusterTimeout

The amount of time Orbit should wait for the initial join cluster to succeed before failing.

val joinClusterTimeout: Duration

messageTimeout

The default timeout for messages.

val messageTimeout: Duration

namespace

The namespace to use when connecting to the Orbit cluster.

val namespace: String

networkRetryAttempts

The amount of times the gRPC network layer will retry.

val networkRetryAttempts: Int

nodeLeaseRenewalFailedHandler

How to handle node lease renewal failure

val nodeLeaseRenewalFailedHandler: ExternallyConfigured<NodeLeaseRenewalFailedHandler>

packages

Packages to scan for addressables.

val packages: List<String>

pool

The pool where Orbit client tasks will run.

val pool: CoroutineDispatcher

railCount

The number of workers that can process a message concurrently.

val railCount: Int

tickRate

The tick rate of the Orbit client.

val tickRate: Duration