Class: GuestEndpoint
Defined in: src/batteries/isolation/protocol.ts:297
Guest-side correlation engine over a PortLike. Owns per-call AbortControllers (aborted on an inbound abort/stream:cancel envelope) and exposes settleCall/pushDelta/endStream/ errorStream for serve.ts to report outcomes back across the wire.
Constructors
Constructor
new GuestEndpoint(port: PortLike, hooks?: GuestEndpointHooks): GuestEndpoint;Defined in: src/batteries/isolation/protocol.ts:303
Parameters
| Parameter | Type |
|---|---|
port | PortLike |
hooks | GuestEndpointHooks |
Returns
GuestEndpoint
Methods
emit()
emit(channel: string, payload: WireValue): void;Defined in: src/batteries/isolation/protocol.ts:382
Emit an unsolicited event on channel.
Parameters
| Parameter | Type |
|---|---|
channel | string |
payload | WireValue |
Returns
void
endStream()
endStream(id: string): void;Defined in: src/batteries/isolation/protocol.ts:370
Signal a stream's clean end and release its abort controller.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
void
errorStream()
errorStream(id: string, error: WireError): void;Defined in: src/batteries/isolation/protocol.ts:376
Signal a stream's terminal error and release its abort controller.
Parameters
| Parameter | Type |
|---|---|
id | string |
error | WireError |
Returns
void
pushDelta()
pushDelta(id: string, delta: WireValue): void;Defined in: src/batteries/isolation/protocol.ts:365
Push a stream delta.
Parameters
| Parameter | Type |
|---|---|
id | string |
delta | WireValue |
Returns
void
ready()
ready(encoderAvailable: boolean): void;Defined in: src/batteries/isolation/protocol.ts:348
Announce readiness. Must be sent exactly once, before any result/stream:*/event envelope.
Parameters
| Parameter | Type |
|---|---|
encoderAvailable | boolean |
Returns
void
settleError()
settleError(id: string, error: WireError): void;Defined in: src/batteries/isolation/protocol.ts:359
Report a failed call outcome and release the call's abort controller.
Parameters
| Parameter | Type |
|---|---|
id | string |
error | WireError |
Returns
void
settleOk()
settleOk(id: string, value: WireValue): void;Defined in: src/batteries/isolation/protocol.ts:353
Report a successful call outcome and release the call's abort controller.
Parameters
| Parameter | Type |
|---|---|
id | string |
value | WireValue |
Returns
void