WebPubSubClientOptions interface
クライアント オプション
プロパティ
| auto |
接続が切断され、回復できない後に自動再接続するかどうかを指定します。 |
| auto |
再接続後にグループの復元を有効にするかどうか |
| keep |
これは、実行時にキープアライブpingメッセージを送信するためのミリ秒単位の間隔です。 デフォルトは20000ms(20秒)です。 クライアント主導のキープアライブpingを無効にするには0に設定してください。 0 以上である必要があります。 タイムアウトは複数回のping失敗時にのみトリガーされるように、 |
| keep |
データやポンが受信されていない場合に半開き接続を検出するために使われるアイドルタイムアウト(ミリ秒単位)。 デフォルトは120000ms(120秒)です。 このタイムアウトチェックを無効にするには0に設定してください。 0 以上である必要があります。 この値を |
| message |
グループへの参加やメッセージの送信などの操作の再試行オプション |
| protocol | サブプロトコル |
| reconnect |
再接続の再試行オプション。 autoReconnect が true の場合にのみ使用できます。 |
プロパティの詳細
autoReconnect
接続が切断され、回復できない後に自動再接続するかどうかを指定します。
autoReconnect?: booleanプロパティ値
boolean
autoRejoinGroups
再接続後にグループの復元を有効にするかどうか
autoRejoinGroups?: booleanプロパティ値
boolean
keepAliveIntervalInMs
これは、実行時にキープアライブpingメッセージを送信するためのミリ秒単位の間隔です。 デフォルトは20000ms(20秒)です。 クライアント主導のキープアライブpingを無効にするには0に設定してください。 0 以上である必要があります。 タイムアウトは複数回のping失敗時にのみトリガーされるように、 keepAliveTimeoutInMs より低い値(約3倍)を選ぶことをおすすめします。
keepAliveIntervalInMs?: numberプロパティ値
number
keepAliveTimeoutInMs
データやポンが受信されていない場合に半開き接続を検出するために使われるアイドルタイムアウト(ミリ秒単位)。 デフォルトは120000ms(120秒)です。 このタイムアウトチェックを無効にするには0に設定してください。 0 以上である必要があります。 この値を keepAliveIntervalInMs より快適に大きく(例えば3倍)に保つことを推奨します。これにより、プローブがタイムアウトでソケットが閉じる前に動作する時間が確保されます。
keepAliveTimeoutInMs?: numberプロパティ値
number
messageRetryOptions
グループへの参加やメッセージの送信などの操作の再試行オプション
messageRetryOptions?: WebPubSubRetryOptionsプロパティ値
protocol
reconnectRetryOptions
再接続の再試行オプション。 autoReconnect が true の場合にのみ使用できます。
reconnectRetryOptions?: WebPubSubRetryOptions