OnGroupStreamOptions interface

Pakiet:
@azure/web-pubsub-client

Opcje kontrolujące sposób śledzenia i wysyłania strumieni grupowych przychodzących dla pojedynczego callback zarejestrowanego przez .client.onGroupStream(callback, options)

Granularność jest dwupoziomowa:

  • Wartości opcji są przypisane do rejestracji (czyli dla każdego handlera): każde onGroupStream wywołanie ma swoje wartości, a różne handlery mogą używać różnych wartości.
  • Efekty opcji są stosowane niezależnie do każdego strumienia, rozpoznanego przez (group, streamId) jego parę. Strumienie współczesne — nawet dwa strumienie w tej samej grupie obserwowane przez tego samego handlera — każdy mają własny timer bezczynności i handleFromStart własną bramę. Nic nie jest udostępniane ani agregowane między strumieniami czy grupami.

Właściwości

groupNames

Opcjonalne nazwy grup do odbierania strumieni. Po pominięciu odbierane są strumienie ze wszystkich grup.
handleFromStart

Czy wymagać, aby pierwszy zaobserwowany fragment strumienia zaczynał się od , streamSequenceId === 1oceniano niezależnie na strumień (zidentyfikowany przez (group, streamId) parę). Jeśli prawdziwy i pierwszy zaobserwowany fragment strumienia znajduje się w połowie strumienia, ten strumień jest ignorowany do momentu dotarcia do ramy końcowej, bez wpływu na inny równoczesny strumień. Wartość domyślna: false.
idleTimeoutInMs

Czas nieaktywności w milisekundach, stosowany niezależnie do każdego strumienia (rozpoznanego przez (group, streamId) parę). Każdy strumień ma swój własny timer, który resetuje się, gdy pojawia się fragment tego strumienia. Jeśli żaden fragment nie dotrze w tym czasie, tylko ten strumień jest zakończony błędem IdleTimeout ; strumienie rodzeństwa tego samego handlera pozostają niedotknięte. Domyślne: 300000 (5 minut).

Szczegóły właściwości

groupNames

Opcjonalne nazwy grup do odbierania strumieni. Po pominięciu odbierane są strumienie ze wszystkich grup.

groupNames?: string[]

Wartość właściwości

string[]

handleFromStart

Czy wymagać, aby pierwszy zaobserwowany fragment strumienia zaczynał się od , streamSequenceId === 1oceniano niezależnie na strumień (zidentyfikowany przez (group, streamId) parę). Jeśli prawdziwy i pierwszy zaobserwowany fragment strumienia znajduje się w połowie strumienia, ten strumień jest ignorowany do momentu dotarcia do ramy końcowej, bez wpływu na inny równoczesny strumień. Wartość domyślna: false.

handleFromStart?: boolean

Wartość właściwości

boolean

idleTimeoutInMs

Czas nieaktywności w milisekundach, stosowany niezależnie do każdego strumienia (rozpoznanego przez (group, streamId) parę). Każdy strumień ma swój własny timer, który resetuje się, gdy pojawia się fragment tego strumienia. Jeśli żaden fragment nie dotrze w tym czasie, tylko ten strumień jest zakończony błędem IdleTimeout ; strumienie rodzeństwa tego samego handlera pozostają niedotknięte. Domyślne: 300000 (5 minut).

idleTimeoutInMs?: number

Wartość właściwości

number