Member Junction
    Preparing search index...

    Interface RealtimeRelayIssueParams

    The parameters for RealtimeProxyRegistry.IssueRelaySession. Omitted limits take the defaults above.

    interface RealtimeRelayIssueParams {
        DriverClass?: string;
        LifetimeSeconds?: number;
        MaxConnections?: number;
        MaxSessionSeconds?: number;
        OpenWithinSeconds?: number;
        Policy: IRealtimeRelayPolicy;
        UpstreamUrl: string;
        UserID?: string;
    }
    Index

    Properties

    DriverClass? LifetimeSeconds? MaxConnections? MaxSessionSeconds? OpenWithinSeconds? Policy UpstreamUrl UserID?

    Properties

    DriverClass?: string

    The driver class that minted the session (logs).

    LifetimeSeconds?: number

    The relay's own ceiling on the session's life, in seconds (REALTIME_RELAY_SESSION_LIFETIME_SECONDS).

    MaxConnections?: number

    The most connections the session accepts (REALTIME_RELAY_MAX_CONNECTIONS).

    MaxSessionSeconds?: number

    The MJ session cap (RealtimeSessionParams.MaxSessionSeconds) when one applies: the session ends at whichever of this and LifetimeSeconds comes first.

    OpenWithinSeconds?: number

    Seconds after the mint during which the one fresh connection may open (REALTIME_RELAY_OPEN_WINDOW_SECONDS).

    Policy: IRealtimeRelayPolicy

    The provider's frame policy for this session.

    UpstreamUrl: string

    The upstream websocket URL. Server side only: never sent to the browser and never logged.

    UserID?: string

    The MJ user the session was minted for (audit).

    Settings

    Member Visibility

    On This Page

    Properties