GrpcServerActor
Defined in: src/io/broker/GrpcServerActor.ts:78
gRPC server actor. Differs from the BrokerActor base shape — a
server is bound, not connected; there are no outbound messages
the actor itself produces. Handlers run independently and forward
inbound calls to user-supplied target actors.
Lifecycle:
preStart: load proto, build server, register methods, bind.postStop: gracefultryShutdown, thenforceShutdownafter a short grace period.
Extends
Section titled “Extends”Actor<unknown>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GrpcServerActor(
_ctorSettings):GrpcServerActor
Defined in: src/io/broker/GrpcServerActor.ts:83
Parameters
Section titled “Parameters”_ctorSettings
Section titled “_ctorSettings”Partial<GrpcServerSettings>
Returns
Section titled “Returns”GrpcServerActor
Overrides
Section titled “Overrides”Accessors
Section titled “Accessors”isBound
Section titled “isBound”Get Signature
Section titled “Get Signature”get isBound():
boolean
Defined in: src/io/broker/GrpcServerActor.ts:116
Bound port (useful when bind: '0.0.0.0:0' was used to let the OS pick).
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”onReceive()
Section titled “onReceive()”onReceive(
_):void
Defined in: src/io/broker/GrpcServerActor.ts:113
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”unknown
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():
Promise<void>
Defined in: src/io/broker/GrpcServerActor.ts:91
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?”unknown
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/GrpcServerActor.ts:85
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.