Class: GuestEndpoint

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

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:442

Parameters

Parameter	Type
port	PortLike
hooks	GuestEndpointHooks

Returns

GuestEndpoint

Methods

emit()

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

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

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:536

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:542

Signal a stream's terminal error and release its abort controller.

Parameters

Parameter	Type
id	string
error	WireError

Returns

void

---

hostcall()

hostcall(
   method: string,
   args: WireValue[],
   maxBytes?: number): {
  id: string;
  promise: Promise<string | WireValue>;
};

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

Issue a guest-to-host capability request using the separate hostcall id space.

Parameters

Parameter	Type
method	string
args	WireValue[]
maxBytes?	number

Returns

{
  id: string;
  promise: Promise<string | WireValue>;
}

Name	Type	Defined in
id	string	src/batteries/isolation/protocol.ts:501
promise	Promise<string | WireValue>	src/batteries/isolation/protocol.ts:501

---

pushDelta()

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

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

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:514

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:525

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:519

Report a successful call outcome and release the call's abort controller.

Parameters

Parameter	Type
id	string
value	WireValue

Returns

void

---

terminate()

terminate(reason?: string): void;

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

Reject all guest capability requests when this endpoint is stopped.

Parameters

Parameter	Type	Default value
reason	string	'GuestEndpoint has been terminated'

Returns

void