Skip to content
2 min read · 337 words

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

ts
new GuestEndpoint(port: PortLike, hooks?: GuestEndpointHooks): GuestEndpoint;

Defined in: src/batteries/isolation/protocol.ts:303

Parameters

ParameterType
portPortLike
hooksGuestEndpointHooks

Returns

GuestEndpoint

Methods

emit()

ts
emit(channel: string, payload: WireValue): void;

Defined in: src/batteries/isolation/protocol.ts:382

Emit an unsolicited event on channel.

Parameters

ParameterType
channelstring
payloadWireValue

Returns

void


endStream()

ts
endStream(id: string): void;

Defined in: src/batteries/isolation/protocol.ts:370

Signal a stream's clean end and release its abort controller.

Parameters

ParameterType
idstring

Returns

void


errorStream()

ts
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

ParameterType
idstring
errorWireError

Returns

void


pushDelta()

ts
pushDelta(id: string, delta: WireValue): void;

Defined in: src/batteries/isolation/protocol.ts:365

Push a stream delta.

Parameters

ParameterType
idstring
deltaWireValue

Returns

void


ready()

ts
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

ParameterType
encoderAvailableboolean

Returns

void


settleError()

ts
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

ParameterType
idstring
errorWireError

Returns

void


settleOk()

ts
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

ParameterType
idstring
valueWireValue

Returns

void