OnGroupStreamOptions interface

Paquete:: @azure/web-pubsub-client

Opciones que controlan cómo se rastrean y despachan los flujos de grupo entrantes para una sola llamada registrada vía client.onGroupStream(callback, options).

La granularidad es de dos niveles:

Los valores de la opción se asignan al registro (es decir, por manejador): cada onGroupStream llamada lleva sus propios valores, y diferentes manejadores pueden usar valores distintos.
Los efectos de opción se aplican de forma independiente a cada flujo, identificados por su (group, streamId) par. Los flujos concurrentes — incluso dos flujos en el mismo grupo observados por el mismo manejador — tienen cada uno su propio temporizador inactivo y su propia handleFromStart puerta. Nada se comparte ni agrega entre flujos o grupos.

Propiedades

groupNames	Nombres opcionales de grupos para recibir streams. Cuando se omite, se reciben transmisiones de todos los grupos.
handleFromStart	Si se requiere que el primer fragmento observado de un arroyo comience en `streamSequenceId === 1`, evaluado de forma independiente por cada arroyo (identificado por su `(group, streamId)` par). Si es cierto y el primer fragmento observado para un flujo está a mitad de corriente, ese flujo se ignora hasta que llega su marco terminal, sin afectar a ningún otro flujo concurrente. Valor predeterminado: false.
idleTimeoutInMs	Tiempo de inactividad en milisegundos, aplicado de forma independiente a cada flujo (identificado por su `(group, streamId)` par). Cada flujo tiene su propio temporizador que se reinicia cada vez que llega un fragmento para ese flujo. Si no llega ningún fragmento dentro de este periodo, solo ese flujo termina con un `IdleTimeout` error; los flujos hermanos del mismo manejador no se ven afectados. Por defecto: 300000 (5 minutos).

Detalles de las propiedades

groupNames

Nombres opcionales de grupos para recibir streams. Cuando se omite, se reciben transmisiones de todos los grupos.

groupNames?: string[]

Valor de propiedad

string[]

handleFromStart

Si se requiere que el primer fragmento observado de un arroyo comience en streamSequenceId === 1, evaluado de forma independiente por cada arroyo (identificado por su (group, streamId) par). Si es cierto y el primer fragmento observado para un flujo está a mitad de corriente, ese flujo se ignora hasta que llega su marco terminal, sin afectar a ningún otro flujo concurrente. Valor predeterminado: false.

handleFromStart?: boolean

Valor de propiedad

boolean

idleTimeoutInMs

Tiempo de inactividad en milisegundos, aplicado de forma independiente a cada flujo (identificado por su (group, streamId) par). Cada flujo tiene su propio temporizador que se reinicia cada vez que llega un fragmento para ese flujo. Si no llega ningún fragmento dentro de este periodo, solo ese flujo termina con un IdleTimeout error; los flujos hermanos del mismo manejador no se ven afectados. Por defecto: 300000 (5 minutos).

idleTimeoutInMs?: number

Valor de propiedad

number