Skip to content

Commit bda26af

Browse files
committed
more context in comments
1 parent 79379bd commit bda26af

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/client.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,13 @@ export interface IStartClientOpts {
496496
/**
497497
* The maximum amount of time to wait before timing out the `POST /_matrix/client/v1/delayed_events/{delay_id}` with `action = "restart"` requests.
498498
* If not specified, the default `localTimeoutMs` will be used.
499+
*
500+
* This setting is used in the context of MatrixRTC. We need to restart the dealyed events to make sure
501+
* the HomeServer is sending the delayed rtc leave event. In bad network environments we might end up
502+
* waiting for too long for the event to arrive and we will not send another restart event until the local timeout is reached.
503+
*
504+
* In those scenarios chances for success are higher if we use a lower local timeout to increase the tries we do instead of waiting
505+
* for responses on requests which are stuck.
499506
*/
500507
delayedEventRestartLocalTimeoutMS?: number;
501508

0 commit comments

Comments
 (0)