TurnUnqueueOutcome
What unqueue resolves to: the wire ack, and the retirement the
accepted reclaim produced — the queued submit’s input handed back to the
composer. On a session MuseClient opened, retirement is set for this
session’s own accepted reclaim whatever order the ack and turn/unqueued
arrive in. It is undefined when this session holds no queued entry for the
turn (another client’s submit, say). On a Session you feed through
apply yourself, it is also undefined when turn/unqueued folded first:
that apply returned the retirement, so restore the composer from
whichever of the two returned it. Either way it is handed out once.
Properties
Section titled “Properties”| Property | Type | Stability | Presence | Description |
|---|---|---|---|---|
ack |
TurnUnqueueResult |
required | ||
retirement |
PendingRetirement<I> | undefined |
required |
Source
clients/sdk-ts/src/facade/turn-handle.ts:225
{ "kind": "Interface", "canonicalPath": "TurnUnqueueOutcome"}