Skip to content

Commit a2702a3

Browse files
committed
revert renaming comments
1 parent 82e14f4 commit a2702a3

1 file changed

Lines changed: 3 additions & 16 deletions

File tree

src/matrixrtc/MatrixRTCSession.ts

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,56 +55,43 @@ export type MatrixRTCSessionEventHandlerMap = {
5555
};
5656

5757
export interface MembershipConfig {
58-
// The proposed name changes follow the following pattern:
59-
// - use membershipEvent for the join event
60-
// - use timeout for anything that is a destructive time period
61-
// - use duration for anything that is a constructive time period
62-
// - use delayedLeaveEvent for anything related to the delayed event login
63-
// - dont use `delay` for anything that is not related to the delayed event login
64-
6558
/**
6659
* The timeout (in milliseconds) after we joined the call, that our membership should expire
6760
* unless we have explicitly updated it.
6861
*
6962
* This is what goes into the m.rtc.member event expiry field.
7063
*/
71-
// membershipEventExpiryTTL
7264
membershipExpiryTimeout?: number; // hours
7365

7466
/**
7567
* The period (in milliseconds) with which we check that our membership event still exists on the
7668
* server. If it is not found we create it again.
7769
*/
78-
// This is currently not used. I also think we do not need it since this information should come down via sync?
7970
memberEventCheckPeriod?: number;
8071

8172
/**
8273
* The minimum delay (in milliseconds) after which we will retry sending the membership event if it
8374
* failed to send.
8475
*/
85-
// rename to: membershipEventMinimumRetryDuration
86-
// membershipEventRateLimit
8776
callMemberEventRetryDelayMinimum?: number;
8877

8978
/**
9079
* The timeout (in milliseconds) with which the deleayed leave event on the server is configured.
9180
* After this time the server will set the event to the disconnected stat if it has not received a keep-alive from the client.
9281
*/
93-
// I would like to rename this to `delayedLeaveEventDelay` (having the word delayed, event, and leave is helpful i think)
94-
membershipServerSideExpiryTimeout?: number; // 15s
82+
membershipServerSideExpiryTimeout?: number;
9583

9684
/**
9785
* The interval (in milliseconds) in which the client will send membership keep-alives to the server.
9886
*/
99-
// rename to: delayedLeaveEventRestartPeriod
100-
membershipKeepAlivePeriod?: number; // 5s
87+
membershipKeepAlivePeriod?: number;
10188

10289
/**
10390
* @deprecated It should be possible to make it stable without this.
10491
*/
105-
// membershipEventJitter
10692
callMemberEventRetryJitter?: number;
10793
}
94+
10895
export interface EncryptionConfig {
10996
/**
11097
* If true, generate and share a media key for this participant,

0 commit comments

Comments
 (0)