---
url: 'https://adk.nht.io/api/@nhtio/adk/batteries/classes/GuestEndpoint.md'
description: >-
  Guest-side correlation engine over a [`PortLike`](https://adk.nht.io/api/@nhtio/adk/batteries/interfaces/PortLike). Owns per-call
  `AbortController`s (aborted on an inbound `abort`/`stream:cancel` envelope)
  and exposes `settleCall`/`pushDelta`/`endStream`/ `errorStream` for `serve.ts`
  to report outcomes back across the wire.
---

# Class: GuestEndpoint

Defined in: [src/batteries/isolation/protocol.ts:297](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L297)

Guest-side correlation engine over a [PortLike](../interfaces/PortLike.md). Owns per-call `AbortController`s (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](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L303)

#### Parameters

| Parameter | Type                                                        |
| --------- | ----------------------------------------------------------- |
| `port`    | [`PortLike`](../interfaces/PortLike.md)                     |
| `hooks`   | [`GuestEndpointHooks`](../interfaces/GuestEndpointHooks.md) |

#### Returns

`GuestEndpoint`

## Methods

### emit()

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

Defined in: [src/batteries/isolation/protocol.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L382)

Emit an unsolicited event on `channel`.

#### Parameters

| Parameter | Type                                        |
| --------- | ------------------------------------------- |
| `channel` | `string`                                    |
| `payload` | [`WireValue`](../type-aliases/WireValue.md) |

#### Returns

`void`

***

### endStream()

```ts
endStream(id: string): void;
```

Defined in: [src/batteries/isolation/protocol.ts:370](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L370)

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

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `id`      | `string` |

#### Returns

`void`

***

### errorStream()

```ts
errorStream(id: string, error: WireError): void;
```

Defined in: [src/batteries/isolation/protocol.ts:376](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L376)

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

#### Parameters

| Parameter | Type                                      |
| --------- | ----------------------------------------- |
| `id`      | `string`                                  |
| `error`   | [`WireError`](../interfaces/WireError.md) |

#### Returns

`void`

***

### pushDelta()

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

Defined in: [src/batteries/isolation/protocol.ts:365](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L365)

Push a stream delta.

#### Parameters

| Parameter | Type                                        |
| --------- | ------------------------------------------- |
| `id`      | `string`                                    |
| `delta`   | [`WireValue`](../type-aliases/WireValue.md) |

#### Returns

`void`

***

### ready()

```ts
ready(encoderAvailable: boolean): void;
```

Defined in: [src/batteries/isolation/protocol.ts:348](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L348)

Announce readiness. Must be sent exactly once, before any `result`/`stream:*`/`event` envelope.

#### Parameters

| Parameter          | Type      |
| ------------------ | --------- |
| `encoderAvailable` | `boolean` |

#### Returns

`void`

***

### settleError()

```ts
settleError(id: string, error: WireError): void;
```

Defined in: [src/batteries/isolation/protocol.ts:359](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L359)

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

#### Parameters

| Parameter | Type                                      |
| --------- | ----------------------------------------- |
| `id`      | `string`                                  |
| `error`   | [`WireError`](../interfaces/WireError.md) |

#### Returns

`void`

***

### settleOk()

```ts
settleOk(id: string, value: WireValue): void;
```

Defined in: [src/batteries/isolation/protocol.ts:353](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/isolation/protocol.ts#L353)

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

#### Parameters

| Parameter | Type                                        |
| --------- | ------------------------------------------- |
| `id`      | `string`                                    |
| `value`   | [`WireValue`](../type-aliases/WireValue.md) |

#### Returns

`void`