RawStreamSession

A streaming call driven one encoded batch at a time.

Mirrors StreamSession turn for turn, but every payload is a RawBatch rather than decoded rows. Obtained from RpcClient.streamRaw.

Properties

readonly rawHeader: RawBatch | null;

The stream’s header batch, or null when the method declares none.

cancel(): Promise<void>;

Ask the server to stop producing and release the stream’s state.

Best-effort and idempotent: transport failures are swallowed, and the session is finished either way.

Promise<void>

close(): void;

Release the stream without cancelling it.

void

exchangeRaw(input): Promise<RawBatch | null>;

Send one batch (with its custom metadata) and return the reply. Resolves to null when the server ended the stream instead of replying.

Parameter	Type
`input`	`RawBatch`

Promise<RawBatch | null>

nextWithTokenRaw(): Promise<
  | RawBatchWithToken
| null>;

Pull the next producer batch together with the token that resumes the stream after it. Resolves to null at end of stream.

Promise< | RawBatchWithToken | null>

tickRaw(metadata?): Promise<RawBatch | null>;

Pull the next batch from a producer stream, sending metadata as the tick’s application custom metadata. Resolves to null at end of stream.

Parameter	Type
`metadata?`	`ReadonlyMap`<`string`, `string`>

Promise<RawBatch | null>