OnGroupStreamOptions interface

Balíček:
@azure/web-pubsub-client

Možnosti ovládající způsob, jakým jsou příchozí skupinové streamy sledovány a odesílány pro jeden callback registrovaný přes client.onGroupStream(callback, options).

Granularita je dvouúrovňová:

  • Hodnoty opcí jsou omezeny na registraci (tj. na každého handlera): každé onGroupStream volání nese své vlastní hodnoty a různí handleři mohou používat různé hodnoty.
  • Opční efekty se aplikují nezávisle na každý proud, identifikovaný jeho (group, streamId) párem. Současné toky — dokonce i dva proudy ve stejné skupině pozorované stejným handlerem — mají každý svůj vlastní nečinný časovač a handleFromStart vlastní bránu. Nic se nesdílí ani agreguje napříč streamy nebo skupinami.

Vlastnosti

groupNames

Volitelné názvy skupin pro příjem streamů. Pokud je vynechán, přijímají se proudy ze všech skupin.
handleFromStart

Zda má být požadováno, aby první pozorovaný fragment toku začínal v , streamSequenceId === 1vyhodnocováno nezávisle na každý proud (identifikovaný podle jeho (group, streamId) páru). Pokud je pravda a první pozorovaný fragment proudu je uprostřed proudu, tento proud je ignorován, dokud nedorazí jeho terminální rámec, aniž by to ovlivnilo jakýkoli jiný souběžný tok. Výchozí hodnota: false.
idleTimeoutInMs

Časový limit nečinnosti v milisekundách, aplikovaný nezávisle na každý proud (identifikovaný podle (group, streamId) páru). Každý stream má svůj vlastní časovač, který se resetuje pokaždé, když dorazí fragment pro daný stream. Pokud v této době žádný fragment nedorazí, je chybou IdleTimeout ukončen pouze tento proud; sourozenecké proudy stejného handleru zůstanou neovlivněny. Výchozí hodnota: 300000 (5 minut).

Podrobnosti vlastnosti

groupNames

Volitelné názvy skupin pro příjem streamů. Pokud je vynechán, přijímají se proudy ze všech skupin.

groupNames?: string[]

Hodnota vlastnosti

string[]

handleFromStart

Zda má být požadováno, aby první pozorovaný fragment toku začínal v , streamSequenceId === 1vyhodnocováno nezávisle na každý proud (identifikovaný podle jeho (group, streamId) páru). Pokud je pravda a první pozorovaný fragment proudu je uprostřed proudu, tento proud je ignorován, dokud nedorazí jeho terminální rámec, aniž by to ovlivnilo jakýkoli jiný souběžný tok. Výchozí hodnota: false.

handleFromStart?: boolean

Hodnota vlastnosti

boolean

idleTimeoutInMs

Časový limit nečinnosti v milisekundách, aplikovaný nezávisle na každý proud (identifikovaný podle (group, streamId) páru). Každý stream má svůj vlastní časovač, který se resetuje pokaždé, když dorazí fragment pro daný stream. Pokud v této době žádný fragment nedorazí, je chybou IdleTimeout ukončen pouze tento proud; sourozenecké proudy stejného handleru zůstanou neovlivněny. Výchozí hodnota: 300000 (5 minut).

idleTimeoutInMs?: number

Hodnota vlastnosti

number