TcpServerOptionsType
Defined in: src/io/broker/TcpServerOptions.ts:19
Common options 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
Section titled “Extends”Properties
Section titled “Properties”bindHost?
Section titled “bindHost?”
readonlyoptionalbindHost?:string
Defined in: src/io/broker/TcpServerOptions.ts:21
Local bind address. Default: '0.0.0.0'.
bindPort?
Section titled “bindPort?”
readonlyoptionalbindPort?:number
Defined in: src/io/broker/TcpServerOptions.ts:23
Local port. Required; 0 lets the OS pick (read back via boundPort).
circuitBreaker?
Section titled “circuitBreaker?”
readonlyoptionalcircuitBreaker?:object
Defined in: src/io/broker/BrokerOptions.ts:48
Optional circuit-breaker around connectImplementation. After
failureThreshold consecutive failed connect attempts the breaker
opens for resetMs and rejects new attempts immediately.
failureThreshold
Section titled “failureThreshold”
readonlyfailureThreshold:number
resetMs
Section titled “resetMs”
readonlyresetMs:number
Inherited from
Section titled “Inherited from”BrokerCommonOptionsType.circuitBreaker
framing?
Section titled “framing?”
readonlyoptionalframing?:TcpFraming
Defined in: src/io/broker/TcpServerOptions.ts:25
Frame extraction, applied per accepted connection. Default { kind: 'bytes' }.
maxConnections?
Section titled “maxConnections?”
readonlyoptionalmaxConnections?:number
Defined in: src/io/broker/TcpServerOptions.ts:42
Admission cap on simultaneously accepted connections. A connection
arriving at the cap is closed immediately instead of being registered.
Default: Infinity (unlimited).
outboundBuffer?
Section titled “outboundBuffer?”
readonlyoptionaloutboundBuffer?:number
Defined in: src/io/broker/BrokerOptions.ts:61
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
Section titled “Inherited from”BrokerCommonOptionsType.outboundBuffer
reconnect?
Section titled “reconnect?”
readonlyoptionalreconnect?:false| {factor?:number;initialDelayMs?:number;maxAttempts?:number;maxDelayMs?:number; }
Defined in: src/io/broker/BrokerOptions.ts:35
Reconnect strategy applied when the underlying connection drops or
connectImplementation 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
Section titled “Union Members”false
Type Literal
Section titled “Type Literal”{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }
factor?
Section titled “factor?”
readonlyoptionalfactor?:number
initialDelayMs?
Section titled “initialDelayMs?”
readonlyoptionalinitialDelayMs?:number
maxAttempts?
Section titled “maxAttempts?”
readonlyoptionalmaxAttempts?:number
Cap on retry attempts. Default: Infinity (retry forever).
maxDelayMs?
Section titled “maxDelayMs?”
readonlyoptionalmaxDelayMs?:number
Inherited from
Section titled “Inherited from”BrokerCommonOptionsType.reconnect
target?
Section titled “target?”
readonlyoptionaltarget?:ActorRef<TcpServerMessage>
Defined in: src/io/broker/TcpServerOptions.ts:27
Subscriber for every connection event and inbound frame. Required.
readonlyoptionaltls?:TlsTransportOptionsType
Defined in: src/io/broker/TcpServerOptions.ts:36
Serve TLS instead of plaintext. Carries the certificate material, never a path to it — see TlsTransportOptionsType. Deliberately has no HOCON leaf: a config file is the wrong place for a private key.
Supplying ca turns on client-certificate verification (mTLS) unless
requestClientCert: false says otherwise.