DispatchInfo
Defined in: src/types.ts:287
Metadata passed to dispatch hooks before and after RPC method execution.
Properties
Section titled “Properties”authDomain?
Section titled “authDomain?”optional authDomain?: string;Defined in: src/types.ts:308
Authentication domain, empty string when anonymous.
authenticated?
Section titled “authenticated?”optional authenticated?: boolean;Defined in: src/types.ts:310
True when the call was authenticated.
cancelled?
Section titled “cancelled?”optional cancelled?: boolean;Defined in: src/types.ts:321
True when a stream was cancelled by the client.
claims?
Section titled “claims?”optional claims?: Record<string, unknown>;Defined in: src/types.ts:325
Verified claims of the authenticated principal. Emitters MUST redact these by key before writing them — an access log outlives the token it describes.
deferral?
Section titled “deferral?”optional deferral?: AccessLogDeferral;Defined in: src/types.ts:339
Where to hand a record that still needs the final on-wire response size. Installed by transports that can measure it (HTTP); absent elsewhere, in which case a hook emits inline.
externalizedBytes?
Section titled “externalizedBytes?”optional externalizedBytes?: number;Defined in: src/types.ts:335
Bytes uploaded to external storage during this call. These never appear in the response body — only a pointer batch does — so they are invisible to transport-level accounting and are frequently the largest of the three byte figures.
httpStatus?
Section titled “httpStatus?”optional httpStatus?: number;Defined in: src/types.ts:315
HTTP transport: the status code the response went out with. Absent on transports that have no such thing (pipe, Unix socket, TCP).
optional kind?: TransportKind;Defined in: src/types.ts:298
Coarse transport identifier — pipe for stdio, http for fetch
handlers, unix for AF_UNIX.
method
Section titled “method”method: string;Defined in: src/types.ts:289
RPC method name.
methodType
Section titled “methodType”methodType: string;Defined in: src/types.ts:291
“unary” or “stream”.
principal?
Section titled “principal?”optional principal?: string;Defined in: src/types.ts:306
Authenticated principal, empty string when anonymous.
protocol?
Section titled “protocol?”optional protocol?: string;Defined in: src/types.ts:300
Logical service / protocol name.
protocolHash?
Section titled “protocolHash?”optional protocolHash?: string;Defined in: src/types.ts:302
SHA-256 hex of the canonical describe payload (always required in access log).
protocolVersion?
Section titled “protocolVersion?”optional protocolVersion?: string;Defined in: src/types.ts:304
Operator-supplied protocol-contract version label (optional).
remoteAddr?
Section titled “remoteAddr?”optional remoteAddr?: string;Defined in: src/types.ts:312
HTTP transport: remote IP:port.
requestBytes?
Section titled “requestBytes?”optional requestBytes?: number;Defined in: src/types.ts:330
On-wire size of the request body as received, before decompression: what the peer actually sent. Distinct from the logical Arrow byte counts in CallStatistics, which measure what the worker processed and routinely differ by orders of magnitude.
requestData?
Section titled “requestData?”optional requestData?: Uint8Array<ArrayBufferLike>;Defined in: src/types.ts:317
Self-contained Arrow IPC stream of the request batch (unary + stream init only).
requestId
Section titled “requestId”requestId: string | null;Defined in: src/types.ts:295
Client-supplied request identifier, or null.
serverId
Section titled “serverId”serverId: string;Defined in: src/types.ts:293
Server identifier.
sessionAction?
Section titled “sessionAction?”optional sessionAction?: "none" | "resume" | "open" | "close";Defined in: src/types.ts:346
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.
sessionId?
Section titled “sessionId?”optional sessionId?: string;Defined in: src/types.ts:342
Sticky session ID (24-char hex). Present only when the request was bound to a sticky session or the method opened/closed one.
streamId?
Section titled “streamId?”optional streamId?: string;Defined in: src/types.ts:319
Stream lifecycle identifier (32-char lowercase hex); empty on unary.