BrokerActor
Defined in: src/io/broker/BrokerActor.ts:62
Base class for actors that bridge external messaging systems
(MQTT, WebSocket, Kafka, …) into the actor system. Subclasses
implement three protocol hooks (connectImpl, disconnectImpl,
dispatchOutgoing); the base class owns the lifecycle, reconnect-
backoff, outbound buffer, subscriber fan-out, and lifecycle-event
publishing.
Settings precedence (highest first):
- Constructor argument (per-instance overrides).
- HOCON config under
configKey()(system-wide defaults). - Built-in defaults from
builtInDefaults().
Subclasses pass their constructor settings via super(settings) and
implement configKey(), builtInDefaults(), readSettingsFromConfig(),
and requiredSettings() so the base class can resolve and validate
the effective settings before connectImpl() runs.
Extends
Section titled “Extends”Actor<Cmd>
Extended by
Section titled “Extended by”TcpSocketActorUdpSocketActorMqttActorWebSocketActorKafkaActorAmqpActorGrpcClientActorNatsActorJetStreamActorRedisStreamsActorSseActor
Type Parameters
Section titled “Type Parameters”S extends BrokerCommonSettings
Cmd = unknown
P = unknown
Methods
Section titled “Methods”onReceive()
Section titled “onReceive()”
abstractonReceive(message):void|Promise<void>
Defined in: src/Actor.ts:38
Main message handler. Receives each envelope dequeued from the mailbox. A thrown error (sync or async) is caught by the supervisor.
Parameters
Section titled “Parameters”message
Section titled “message”Cmd
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”postRestart()
Section titled “postRestart()”postRestart(
_reason):void|Promise<void>
Defined in: src/Actor.ts:55
Called on the fresh instance after a restart. Default: call preStart().
Parameters
Section titled “Parameters”_reason
Section titled “_reason”Error
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”postStop()
Section titled “postStop()”postStop():
Promise<void>
Defined in: src/io/broker/BrokerActor.ts:241
Called after the actor has been terminated. Children are already stopped.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”preRestart()
Section titled “preRestart()”preRestart(
_reason,_message?):void|Promise<void>
Defined in: src/Actor.ts:50
Called before a restart, on the instance about to be thrown away. The default stops children and then calls postStop().
Parameters
Section titled “Parameters”_reason
Section titled “_reason”Error
_message?
Section titled “_message?”Cmd
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”preStart()
Section titled “preStart()”preStart():
Promise<void>
Defined in: src/io/broker/BrokerActor.ts:235
Called after construction and before the first message is processed.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”supervisorStrategy()
Section titled “supervisorStrategy()”supervisorStrategy():
SupervisorStrategy
Defined in: src/Actor.ts:63
Supervisor strategy for this actor’s children. Defaults to restart, up to 10 times per minute, then stop.