GrpcServerSettings

Defined in: src/io/broker/GrpcServerActor.ts:50

Common settings every broker actor accepts on top of its protocol- specific options. Subclasses extend this interface with their own required fields (e.g. brokerUrl, topics).

Extends

• BrokerCommonSettings

Properties

bind?

readonly optional bind?: string

Defined in: src/io/broker/GrpcServerActor.ts:55

Bind address ('0.0.0.0:50051').

---

circuitBreaker?

readonly optional circuitBreaker?: object

Defined in: src/io/broker/BrokerSettings.ts:28

Optional circuit-breaker around connectImpl. After failureThreshold consecutive failed connect attempts the breaker opens for resetMs and rejects new attempts immediately.

failureThreshold

readonly failureThreshold: number

resetMs

readonly resetMs: number

Inherited from

BrokerCommonSettings.circuitBreaker

---

credentials?

readonly optional credentials?: { kind: "insecure"; } | { cert: Uint8Array; key: Uint8Array; kind: "tls"; rootCerts?: Uint8Array<ArrayBufferLike>; }

Defined in: src/io/broker/GrpcServerActor.ts:62

TLS — when omitted, the server binds insecurely. For mTLS supply cert + key + (optionally) rootCerts for client auth.

---

handlers?

readonly optional handlers?: Readonly<Record<string, GrpcHandler>>

Defined in: src/io/broker/GrpcServerActor.ts:57

Method-name → handler mapping. Methods absent from this map are unimplemented (UNIMPLEMENTED status).

---

outboundBuffer?

readonly optional outboundBuffer?: number

Defined in: src/io/broker/BrokerSettings.ts:41

Maximum number of outbound messages buffered while the connection is connecting or disconnected. When the buffer is full the oldest message is dropped (FIFO eviction) and a BrokerBufferOverflow event is published. Default: 1000. Set to 0 to fail-fast (publish a BrokerNotConnected event and drop the message).

Inherited from

BrokerCommonSettings.outboundBuffer

---

packageName?

readonly optional packageName?: string

Defined in: src/io/broker/GrpcServerActor.ts:52

---

protoPath?

readonly optional protoPath?: string | readonly string[]

Defined in: src/io/broker/GrpcServerActor.ts:51

---

reconnect?

readonly optional reconnect?: false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

Defined in: src/io/broker/BrokerSettings.ts:15

Reconnect strategy applied when the underlying connection drops or connectImpl throws. Default: exponential backoff starting at 200ms, doubling, capped at 30s, infinite attempts. Set to false to disable auto-reconnect (one-shot connections).

Union Members

false

---

Type Literal

{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

factor?

readonly optional factor?: number

initialDelayMs?

readonly optional initialDelayMs?: number

maxAttempts?

readonly optional maxAttempts?: number

Cap on retry attempts. Default: Infinity (retry forever).

maxDelayMs?

readonly optional maxDelayMs?: number

Inherited from

BrokerCommonSettings.reconnect

---

serviceName?

readonly optional serviceName?: string

Defined in: src/io/broker/GrpcServerActor.ts:53