OnGroupStreamOptions interface

Paket:
@azure/web-pubsub-client

Gelen grup akışlarının nasıl takip edildiğini ve tek bir geri dönüş için client.onGroupStream(callback, options)gönderildiğini kontrol eden seçenekler.

Granülarlık iki seviyelidir:

  • Opsiyon değerleri kayıt kapsamına (yani her bir işleyici başı) bağlıdır: her onGroupStream çağrı kendi değerlerini taşır ve farklı yöneticiler farklı değerler kullanabilir.
  • Seçenek etkileri her akışa bağımsız olarak uygulanır ve çiftiyle (group, streamId) tanımlanır. Eşzamanlı akışlar — aynı grupta aynı yönetici tarafından gözlemlenen iki akış bile — her biri kendi boşta zamanlayıcısına ve kendi handleFromStart kapısına sahip. Hiçbir şey akışlar veya gruplar arasında paylaşılmaz veya toplanmaz.

Özellikler

groupNames

Akış almak için isteğe bağlı grup isimleri. Atıldığında, tüm gruplardan akışlar alınır.
handleFromStart

Bir akışın ilk gözlemlenen parçasının başlangıcı gerektirip streamSequenceId === 1gerekmediği, her akış için bağımsız olarak değerlendirilir (çiftiyle (group, streamId) tanımlanır). Eğer doğruyse ve bir akış için ilk gözlemlenen parça orta akış ise, o akış terminal çerçevesine kadar göz ardı edilir ve diğer eşzamanlı akım etkilenmez. Varsayılan: false.
idleTimeoutInMs

Hareketsizlik süresi milisaniyeler cinsinden, her akışa bağımsız olarak uygulanır (çiftiyle (group, streamId) tanımlanır). Her akışın kendi zamanlayıcısı vardır ve bu zaman bir parça geldiğinde sıfırlanır. Bu süre içinde hiçbir parça gelmezse, sadece o akış bir IdleTimeout hata ile sonlandırılır; aynı işleyicinin kardeş akışları etkilenmez. Varsayılan: 300000 (5 dakika).

Özellik Ayrıntıları

groupNames

Akış almak için isteğe bağlı grup isimleri. Atıldığında, tüm gruplardan akışlar alınır.

groupNames?: string[]

Özellik Değeri

string[]

handleFromStart

Bir akışın ilk gözlemlenen parçasının başlangıcı gerektirip streamSequenceId === 1gerekmediği, her akış için bağımsız olarak değerlendirilir (çiftiyle (group, streamId) tanımlanır). Eğer doğruyse ve bir akış için ilk gözlemlenen parça orta akış ise, o akış terminal çerçevesine kadar göz ardı edilir ve diğer eşzamanlı akım etkilenmez. Varsayılan: false.

handleFromStart?: boolean

Özellik Değeri

boolean

idleTimeoutInMs

Hareketsizlik süresi milisaniyeler cinsinden, her akışa bağımsız olarak uygulanır (çiftiyle (group, streamId) tanımlanır). Her akışın kendi zamanlayıcısı vardır ve bu zaman bir parça geldiğinde sıfırlanır. Bu süre içinde hiçbir parça gelmezse, sadece o akış bir IdleTimeout hata ile sonlandırılır; aynı işleyicinin kardeş akışları etkilenmez. Varsayılan: 300000 (5 dakika).

idleTimeoutInMs?: number

Özellik Değeri

number