OnGroupStreamOptions interface

Opzioni che controllano come vengono tracciati e inviati i flussi di gruppo in entrata per un singolo callback registrati tramite client.onGroupStream(callback, options).

La granularità è a due livelli:

  • I valori delle opzioni sono assegnati alla registrazione (cioè per handler): ogni onGroupStream chiamata porta i propri valori, e diversi handler possono usare valori differenti.
  • Gli effetti delle opzioni vengono applicati indipendentemente a ciascun flusso, identificati dalla sua (group, streamId) coppia. I flussi concorrenti — anche due flussi nello stesso gruppo osservati dallo stesso gestore — hanno ciascuno il proprio timer inattivo e il proprio handleFromStart gate. Nulla viene condiviso o aggregato tra flussi o gruppi.

Proprietà

groupNames

Nomi di gruppi opzionali da cui ricevere gli streaming. Quando viene omesso, vengono ricevuti flussi da tutti i gruppi.

handleFromStart

Se richiedere che il primo frammento osservato di un corso inizi in streamSequenceId === 1, valutato indipendentemente per ogni flusso (identificato dalla sua (group, streamId) coppia). Se è vero e il primo frammento osservato per un flusso è a metà flusso, quel flusso viene ignorato fino all'arrivo del suo sistema terminale, senza influenzare alcun altro flusso concorrente. Valore predefinito: false.

idleTimeoutInMs

Timeout di inattività in millisecondi, applicato indipendentemente a ogni flusso (identificato dalla sua (group, streamId) coppia). Ogni flusso ha il proprio timer che viene resettato ogni volta che arriva un frammento per quel flusso. Se nessun frammento arriva entro questa durata, solo quel flusso viene terminato con un IdleTimeout errore; i flussi fratelli dello stesso handler non sono influenzati. Predefinito: 300000 (5 minuti).

Dettagli proprietà

groupNames

Nomi di gruppi opzionali da cui ricevere gli streaming. Quando viene omesso, vengono ricevuti flussi da tutti i gruppi.

groupNames?: string[]

Valore della proprietà

string[]

handleFromStart

Se richiedere che il primo frammento osservato di un corso inizi in streamSequenceId === 1, valutato indipendentemente per ogni flusso (identificato dalla sua (group, streamId) coppia). Se è vero e il primo frammento osservato per un flusso è a metà flusso, quel flusso viene ignorato fino all'arrivo del suo sistema terminale, senza influenzare alcun altro flusso concorrente. Valore predefinito: false.

handleFromStart?: boolean

Valore della proprietà

boolean

idleTimeoutInMs

Timeout di inattività in millisecondi, applicato indipendentemente a ogni flusso (identificato dalla sua (group, streamId) coppia). Ogni flusso ha il proprio timer che viene resettato ogni volta che arriva un frammento per quel flusso. Se nessun frammento arriva entro questa durata, solo quel flusso viene terminato con un IdleTimeout errore; i flussi fratelli dello stesso handler non sono influenzati. Predefinito: 300000 (5 minuti).

idleTimeoutInMs?: number

Valore della proprietà

number