Interface VisibilityGate

Visibility gate: defers traffic for hidden windows and drains it on return.

interface VisibilityGate {
    defer(windowId: string, envelope: GuardEnvelope): boolean;
    drain(windowId: string): readonly GuardEnvelope[];
    forget(windowId: string): void;
    getVisibility(windowId: string): WindowVisibility;
    setVisibility(windowId: string, visibility: WindowVisibility): void;
    shouldDefer(windowId: string, opClass: OpClass): boolean;
}

Index

Methods

defer drain forget getVisibility setVisibility shouldDefer

Methods

defer

defer(windowId: string, envelope: GuardEnvelope): boolean
Queue an envelope; returns false when the defer queue is full.
Parameters
- windowId: string
- envelope: GuardEnvelope
Returns boolean

drain

drain(windowId: string): readonly GuardEnvelope[]
Return every deferred envelope for a window, oldest first, and clear the queue.
Parameters
- windowId: string
Returns readonly GuardEnvelope[]

forget

forget(windowId: string): void
Parameters
- windowId: string
Returns void

getVisibility

getVisibility(windowId: string): WindowVisibility
Parameters
- windowId: string
Returns WindowVisibility

setVisibility

setVisibility(windowId: string, visibility: WindowVisibility): void
Parameters
- windowId: string
- visibility: WindowVisibility
Returns void

shouldDefer

shouldDefer(windowId: string, opClass: OpClass): boolean
True when envelopes of this class should wait until the window is visible.
Parameters
- windowId: string
- opClass: OpClass
Returns boolean