Skip to content

DispatchInfo

Defined in: src/types.ts:262

Metadata passed to dispatch hooks before and after RPC method execution.

optional authDomain?: string;

Defined in: src/types.ts:283

Authentication domain, empty string when anonymous.


optional authenticated?: boolean;

Defined in: src/types.ts:285

True when the call was authenticated.


optional cancelled?: boolean;

Defined in: src/types.ts:293

True when a stream was cancelled by the client.


optional kind?: TransportKind;

Defined in: src/types.ts:273

Coarse transport identifier — pipe for stdio, http for fetch handlers, unix for AF_UNIX.


method: string;

Defined in: src/types.ts:264

RPC method name.


methodType: string;

Defined in: src/types.ts:266

“unary” or “stream”.


optional principal?: string;

Defined in: src/types.ts:281

Authenticated principal, empty string when anonymous.


optional protocol?: string;

Defined in: src/types.ts:275

Logical service / protocol name.


optional protocolHash?: string;

Defined in: src/types.ts:277

SHA-256 hex of the canonical describe payload (always required in access log).


optional protocolVersion?: string;

Defined in: src/types.ts:279

Operator-supplied protocol-contract version label (optional).


optional remoteAddr?: string;

Defined in: src/types.ts:287

HTTP transport: remote IP:port.


optional requestData?: Uint8Array<ArrayBufferLike>;

Defined in: src/types.ts:289

Self-contained Arrow IPC stream of the request batch (unary + stream init only).


requestId: string | null;

Defined in: src/types.ts:270

Client-supplied request identifier, or null.


serverId: string;

Defined in: src/types.ts:268

Server identifier.


optional sessionAction?: "none" | "resume" | "open" | "close";

Defined in: src/types.ts:300

Sticky-session lifecycle action observed during dispatch — one of "none" / "resume" / "open" / "close". Omitted when sticky is disabled or the request never touched the sticky middleware.


optional sessionId?: string;

Defined in: src/types.ts:296

Sticky session ID (24-char hex). Present only when the request was bound to a sticky session or the method opened/closed one.


optional streamId?: string;

Defined in: src/types.ts:291

Stream lifecycle identifier (32-char lowercase hex); empty on unary.