Class QwpEgressQuery

constructor

• new QwpEgressQuery(
      requestId: bigint,
      control: QwpEgressQueryControl,
      creditEnabled: boolean,
      autoCredit: boolean,
      bufferPoolSize: number,
      timeoutMs: number,
      viewHandler?: QwpResultBatchViewHandler,
  ): QwpEgressQuery

  Parameters

  • requestId: bigint
  • control: QwpEgressQueryControl
  • creditEnabled: boolean
  • autoCredit: boolean
  • bufferPoolSize: number
  • timeoutMs: number
  • OptionalviewHandler: QwpResultBatchViewHandler

  Returns QwpEgressQuery

Readonlycompletion

ReadonlyrequestId

cancelledByUser

• get cancelledByUser(): boolean
  Internal

  Whether the application cancelled before the timeout.

  Returns boolean

pastDeadline

• get pastDeadline(): boolean
  Internal

  Whether the timeout has expired; results are withheld.

  Returns boolean

retired

• get retired(): boolean
  Internal

  Whether the consumer has retired while the wire still drains.

  Returns boolean

usesViews

• get usesViews(): boolean
  Internal

  Returns boolean

[asyncIterator]

• "[asyncIterator]"(): AsyncIterator<QwpResultBatch>

  Returns AsyncIterator<QwpResultBatch>

armDeadline

• armDeadline(remainingMs: number): void
  Internal

  Starts the timeout with what remains of its budget.

  Parameters

  • remainingMs: number

  Returns void

armGrace

• armGrace(graceMs: number): void
  Internal

  Bounds how long an expired query may take to end.

  Parameters

  • graceMs: number

  Returns void

awaitCompletion

• awaitCompletion(timeoutMs: number): Promise<boolean>

  Waits for completion without changing the query lifecycle. A finite wait returns false on expiry; the query remains active until it completes, is cancelled explicitly, or its configured query deadline expires.

  Parameters

  • timeoutMs: number

  Returns Promise<boolean>

cancel

• cancel(): Promise<void>

  Returns Promise<void>

claimCancel

• claimCancel(): boolean
  Internal

  Claims this request's single CANCEL. False once one has been sent: the server ignores a second, so it would only cost a frame.

  Returns boolean

dropLateBatch

• dropLateBatch(creditBytes: number): number
  Internal

  Records a batch dropped unread because the consumer has retired or the timeout has expired, and returns the credit to restore for it.

  Parameters

  • creditBytes: number

  Returns number

fail

• fail(error: unknown): void
  Internal

  Parameters

  • error: unknown

  Returns void

finish

• finish(completion: QwpQueryCompletion): Promise<void>
  Internal

  Parameters

  • completion: QwpQueryCompletion

  Returns Promise<void>

finishError

• finishError(error: QwpEgressQueryError): Promise<void>
  Internal

  Preserves batch/callback order before a wire query error.

  Parameters

  • error: QwpEgressQueryError

  Returns Promise<void>

grantCredit

• grantCredit(additionalBytes: number | bigint): Promise<void>

  Parameters

  • additionalBytes: number | bigint

  Returns Promise<void>

isDone

• isDone(): boolean

  Whether the query has reached any terminal outcome.

  Returns boolean

markCancelledByUser

• markCancelledByUser(): void
  Internal

  Records an application cancel, which outranks the timeout.

  Returns void

pushReserved

• pushReserved(batch: QwpResultBatch, creditBytes: number): void
  Internal

  Publishes a batch after reserveMaterializedBatch().

  Parameters

  • batch: QwpResultBatch
  • creditBytes: number

  Returns void

pushReservedView

• pushReservedView(
      batch: QwpResultBatchView,
      creditBytes: number,
      slot: number,
  ): void
  Internal

  Queues a decoded view after reserveViewBatch().

  Parameters

  • batch: QwpResultBatchView
  • creditBytes: number
  • slot: number

  Returns void

releaseMaterializedBatch

• releaseMaterializedBatch(): void
  Internal

  Releases a reservation when decoding fails.

  Returns void

releaseViewBatch

• releaseViewBatch(slot: number): void
  Internal

  Releases a reservation when zero-copy decoding fails.

  Parameters

  • slot: number

  Returns void

reserveMaterializedBatch

• reserveMaterializedBatch(): Promise<QwpBatchReservation>
  Internal

  Waits for one decoded materialized-batch slot.

  Returns Promise<QwpBatchReservation>

reserveViewBatch

• reserveViewBatch(): Promise<QwpViewBatchReservation>
  Internal

  Waits for one reusable zero-copy view slot.

  Returns Promise<QwpViewBatchReservation>

resetForReplay

• resetForReplay(): Promise<void>
  Internal

  Returns Promise<void>

retire

• retire(error: Error): number
  Internal

  Discards queued results and retires the consumer immediately.

  Parameters

  • error: Error

  Returns number

timeoutError

• timeoutError(): QwpEgressQueryTimeoutError
  Internal

  The error reporting that this query ran out of time.

  Returns QwpEgressQueryTimeoutError

waitForViewDrain

• waitForViewDrain(): Promise<void>
  Internal

  Waits until all callback-scoped views have been released.

  Returns Promise<void>

withholdResults

• withholdResults(): number
  Internal

  Called when the timeout expires. No further batch reaches the consumer: queued ones are dropped. Returns the flow-control credit they held, which the server needs back to stream on toward its terminal.

  Returns number