TcpServerOptionsBuilder
このコンテンツはまだ日本語訳がありません。
Defined in: src/io/broker/TcpServerOptions.ts:45
Extends
Section titled “Extends”BrokerOptionsBuilder<TcpServerOptionsType>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TcpServerOptionsBuilder():
TcpServerOptionsBuilder
Returns
Section titled “Returns”TcpServerOptionsBuilder
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder<TcpServerOptionsType>.constructor
Methods
Section titled “Methods”build()
Section titled “build()”build():
Partial<T>
Defined in: src/util/OptionsBuilder.ts:51
Snapshot the set fields as an independent Partial<T> (own props only).
Returns
Section titled “Returns”Partial<T>
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.build
withBindHost()
Section titled “withBindHost()”withBindHost(
host):this
Defined in: src/io/broker/TcpServerOptions.ts:52
Local bind address. Default '0.0.0.0'.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
withBindPort()
Section titled “withBindPort()”withBindPort(
port):this
Defined in: src/io/broker/TcpServerOptions.ts:57
Local port. Required; 0 lets the OS pick.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withCircuitBreaker()
Section titled “withCircuitBreaker()”withCircuitBreaker(
failureThreshold,resetMs):this
Defined in: src/io/broker/BrokerOptions.ts:125
Circuit breaker around connect attempts.
Parameters
Section titled “Parameters”failureThreshold
Section titled “failureThreshold”number
resetMs
Section titled “resetMs”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.withCircuitBreaker
withFraming()
Section titled “withFraming()”withFraming(
framing):this
Defined in: src/io/broker/TcpServerOptions.ts:62
Frame extraction strategy, applied per connection. Default { kind: 'bytes' }.
Parameters
Section titled “Parameters”framing
Section titled “framing”Returns
Section titled “Returns”this
withMaxConnections()
Section titled “withMaxConnections()”withMaxConnections(
max):this
Defined in: src/io/broker/TcpServerOptions.ts:77
Cap on simultaneously accepted connections. Default Infinity.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withOutboundBuffer()
Section titled “withOutboundBuffer()”withOutboundBuffer(
limit):this
Defined in: src/io/broker/BrokerOptions.ts:130
Outbound buffer size (messages held while disconnected). Default 1000; 0 = fail-fast.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.withOutboundBuffer
withReconnect()
Section titled “withReconnect()”withReconnect(
policy):this
Defined in: src/io/broker/BrokerOptions.ts:120
Reconnect policy (or false to disable auto-reconnect).
Parameters
Section titled “Parameters”policy
Section titled “policy”false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; } | undefined
false
Type Literal
Section titled “Type Literal”{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }
factor?
Section titled “factor?”number
initialDelayMs?
Section titled “initialDelayMs?”number
maxAttempts?
Section titled “maxAttempts?”number
Cap on retry attempts. Default: Infinity (retry forever).
maxDelayMs?
Section titled “maxDelayMs?”number
undefined
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.withReconnect
withTarget()
Section titled “withTarget()”withTarget(
target):this
Defined in: src/io/broker/TcpServerOptions.ts:67
Subscriber for connection events and inbound frames. Required.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”this
withTls()
Section titled “withTls()”withTls(
tls):this
Defined in: src/io/broker/TcpServerOptions.ts:72
Serve TLS. Pass the certificate material itself, not a file path.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():TcpServerOptionsBuilder
Defined in: src/io/broker/TcpServerOptions.ts:47
Start a fresh builder. Equivalent to new TcpServerOptionsBuilder().
Returns
Section titled “Returns”TcpServerOptionsBuilder