WantHandlers
Defined in: relay-sdks/ts/src/supervised-subscriber.ts:144
The callbacks a want delivers to. Like RelaySubscriptionHandlers, they must be synchronous.
Methods
Section titled “Methods”onError()?
Section titled “onError()?”onError?(error): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:173
A failure the want does not retry, after which it stops and is removed: a REQUEST_ERROR no wait fixes (credentials, an unsupported or malformed request), or discovery refusing the root.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
error |
unknown |
Returns
Section titled “Returns”void
onObject()?
Section titled “onObject()?”onObject?(object): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:151
One object, from whichever subscription is current.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
object |
MoqtObject |
Returns
Section titled “Returns”void
onPublisherDone()?
Section titled “onPublisherDone()?”onPublisherDone?(info): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:157
The relay sent PUBLISH_DONE on the current subscription; the want resubscribes after its backoff.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
info |
PublishDone |
Returns
Section titled “Returns”void
onRestarted()?
Section titled “onRestarted()?”onRestarted?(info): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:162
An accepted subscription ended and the want will replace it: drop decoder state that assumed continuity. Called before any object of the replacement; the gap is never filled.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
info |
{ namespace: string[]; reason: RestartReason; } |
info.namespace |
string[] |
info.reason |
RestartReason |
Returns
Section titled “Returns”void
onSubgroupEnd()?
Section titled “onSubgroupEnd()?”onSubgroupEnd?(info): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:153
A subgroup stream ended cleanly.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
info |
{ endOfGroup: boolean; groupId: number; subgroupId: number; } |
info.endOfGroup |
boolean |
info.groupId |
number |
info.subgroupId |
number |
Returns
Section titled “Returns”void
onSubgroupReset()?
Section titled “onSubgroupReset()?”onSubgroupReset?(info): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:155
A subgroup stream was reset.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
info |
{ error: unknown; groupId: number; } |
info.error |
unknown |
info.groupId |
number |
Returns
Section titled “Returns”void
onSubscribed()?
Section titled “onSubscribed()?”onSubscribed?(info, context): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:149
A subscription was accepted; namespace is the one it was made on, the generation’s when following one. A move’s
replacement reports its acceptance in onSwitched instead.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
info |
SubscribeOk |
context |
{ namespace: string[]; } |
context.namespace |
string[] |
Returns
Section titled “Returns”void
onSwitched()?
Section titled “onSwitched()?”onSwitched?(info): void;Defined in: relay-sdks/ts/src/supervised-subscriber.ts:168
A move’s cutover: the want now delivers from to, and from was cancelled or drains its in-flight groups. Runs
before the replacement’s first object, the one that passed until. Decoders drop state that assumed continuity
here; no onRestarted or onSubscribed runs for a move.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
info |
WantSwitchedInfo |
Returns
Section titled “Returns”void