matrix-js-sdk

    Interface MembershipConfig

    interface MembershipConfig {
        delayedLeaveEventDelayMs?: number;
        delayedLeaveEventRestartLocalTimeoutMs?: number;
        delayedLeaveEventRestartMs?: number;
        maximumNetworkErrorRetryCount?: number;
        maximumRateLimitRetryCount?: number;
        membershipEventExpiryHeadroomMs?: number;
        membershipEventExpiryMs?: number;
        networkErrorRetryMs?: number;
        useExperimentalToDeviceTransport?: boolean;
        useNewMembershipManager?: boolean;
    }
    Index

    Properties

    delayedLeaveEventDelayMs?: number

    The timeout (in milliseconds) with which the deleayed leave event on the server is configured. After this time the server will set the event to the disconnected stat if it has not received a keep-alive from the client.

    delayedLeaveEventRestartLocalTimeoutMs?: number

    The time (in milliseconds) after which a we consider a delayed event restart http request to have failed. Setting this to a lower value will result in more frequent retries but also a higher chance of failiour.

    In the presence of network packet loss (hurting TCP connections), the custom delayedEventRestartLocalTimeoutMs helps by keeping more delayed event reset candidates in flight, improving the chances of a successful reset. (its is equivalent to the js-sdk localTimeout configuration, but only applies to calls to the _unstable_updateDelayedEvent endpoint with a body of {action:"restart"}.)

    delayedLeaveEventRestartMs?: number

    The interval (in milliseconds) in which the client will send membership keep-alives to the server.

    maximumNetworkErrorRetryCount?: number

    The maximum number of retries that the manager will do for delayed event sending/updating and state event sending when a network error occurs.

    maximumRateLimitRetryCount?: number

    The maximum number of retries that the manager will do for delayed event sending/updating and state event sending when a server rate limit has been hit.

    membershipEventExpiryHeadroomMs?: number

    The time in (in milliseconds) which the manager will prematurely send the updated state event before the membership expires time to make sure it sends the updated state event early enough.

    A headroom of 1000ms and a membershipExpiryTimeout of 10000ms would result in the first membership event update after 9s and a membership event that would be considered expired after 10s.

    This value does not have an effect on the value of SessionMembershipData.expires.

    membershipEventExpiryMs?: number

    The timeout (in milliseconds) after we joined the call, that our membership should expire unless we have explicitly updated it.

    This is what goes into the m.rtc.member event expiry field and is typically set to a number of hours.

    networkErrorRetryMs?: number

    The time (in milliseconds) after which we will retry a http request if it failed to send due to a network error. (send membership event, send delayed event, restart delayed event...)

    useExperimentalToDeviceTransport?: boolean

    If true, use the new to-device transport for sending encryption keys.

    useNewMembershipManager?: boolean

    Use the new Manager.

    Default: false.

    does nothing anymore we always default to the new membership manager.

    MMNEPVFCICPMFPCPTTAAATR