OnGroupStreamOptions interface
client.onGroupStream(callback, options)で登録された単一のコールバックで、受信グループストリームの追跡とディスパッチ方法を制御するオプション。
粒度は2レベルです:
- オプション 値は 登録(すなわちハンドラごとの)にスコープが割り当てられており、各
onGroupStream呼び出しは独自の値を保持し、異なるハンドラが異なる値を使用できます。 - オプション 効果 は各ストリームに独立して適用され、
(group, streamId)ペアで識別されます。 同時進行ストリーム、例えば同じハンドラーが監視する同じグループ内の2つのストリームであっても、それぞれ独自のアイドルタイマーとhandleFromStartゲートを持ちます。 ストリームやグループ間で共有・集約されることはありません。
プロパティ
| group |
ストリームを受け取るための任意のグループ名。 省略すると、すべてのグループからのストリームが受信されます。 |
| handle |
流の最初の断片を1 |
| idle |
非アクティブタイムアウトはミリ秒単位で、各ストリーム( |
プロパティの詳細
groupNames
ストリームを受け取るための任意のグループ名。 省略すると、すべてのグループからのストリームが受信されます。
groupNames?: string[]プロパティ値
string[]
handleFromStart
流の最初の断片を1 streamSequenceId === 1から開始させることを、各流( (group, streamId) ペアで識別)ごとに独立して評価するかどうか。 もしこれが真で、ストリームの最初の観測断片がストリームの中間にある場合、そのストリームは終端フレームが到着するまで無視され、他の並行ストリームには影響しません。
既定値は false です。
handleFromStart?: booleanプロパティ値
boolean
idleTimeoutInMs
非アクティブタイムアウトはミリ秒単位で、各ストリーム( (group, streamId) ペアで識別)に独立して適用されます。 すべてのストリームには独自のタイマーがあり、そのストリームのフラグメントが到着するたびにリセットされます。 この期間内にフラグメントが到着しなければ、そのストリームのみが IdleTimeout エラーで終了します。同じハンドラーの兄弟ストリームは影響を受けません。
デフォルト:300000(5分)
idleTimeoutInMs?: numberプロパティ値
number