ServerWebSocketActor
Defined in: src/io/broker/ServerWebSocketActor.ts:99
Base class for user actors. Subclasses must override onReceive.
Lifecycle hooks (preStart, postStop, preRestart, postRestart) have sensible
defaults but can be overridden.
Actors are single-threaded by construction: the runtime guarantees that onReceive is never invoked concurrently for the same actor. If onReceive returns a Promise, the runtime awaits it before starting the next message.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ServerWebSocketActor(
socket,opts?):ServerWebSocketActor
Defined in: src/io/broker/ServerWebSocketActor.ts:110
Parameters
Section titled “Parameters”socket
Section titled “socket”ServerWebSocketActorOptions = {}
Returns
Section titled “Returns”ServerWebSocketActor
Overrides
Section titled “Overrides”Methods
Section titled “Methods”onReceive()
Section titled “onReceive()”onReceive(
cmd):void
Defined in: src/io/broker/ServerWebSocketActor.ts:137
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”Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”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():
void
Defined in: src/io/broker/ServerWebSocketActor.ts:123
Called after the actor has been terminated. Children are already stopped.
Returns
Section titled “Returns”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?”Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”preStart()
Section titled “preStart()”preStart():
void
Defined in: src/io/broker/ServerWebSocketActor.ts:116
Called after construction and before the first message is processed.
Returns
Section titled “Returns”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.