Comunica
    Preparing search index...
    interface IActorHttpLimitRateArgs {
        allowOverlap: boolean;
        beforeActors?: Actor<IActionHttp, IActorTest, IActorHttpOutput, undefined>[];
        bus: Bus<
            Actor<IActionHttp, IActorTest, IActorHttpOutput, undefined>,
            IActionHttp,
            IActorTest,
            IActorHttpOutput,
            undefined,
        >;
        busFailMessage?: string;
        correctionMultiplier: number;
        failureMultiplier: number;
        httpInvalidator: ActorHttpInvalidateListenable;
        limitByDefault: boolean;
        mediatorHttp: MediatorHttp;
        name: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowOverlap: boolean

    Whether requests should be allowed to overlap, instead of being effectively queued one after another for a host. Enabling this behaviour may help with overall performance, but will make the rate limiter less accurate, and make it impossible for the limiter to smooth out large bursts of requests to a given host.

    {false}
    
    beforeActors?: Actor<IActionHttp, IActorTest, IActorHttpOutput, undefined>[]

    Actor that must be registered in the bus before this actor.

    bus: Bus<
        Actor<IActionHttp, IActorTest, IActorHttpOutput, undefined>,
        IActionHttp,
        IActorTest,
        IActorHttpOutput,
        undefined,
    >

    The bus this actor subscribes to.

    busFailMessage?: string

    The message that will be configured in the bus for reporting failures.

    This message may be a template string that contains references to the executed action. For example, the following templated string is allowed: "RDF dereferencing failed: no actors could handle ${action.handle.mediaType}"

    correctionMultiplier: number

    Multiplier for how aggressively the delay should follow the latest response time, ideally in range ]0.0, 1.0].

    {0.1}
    
    failureMultiplier: number

    The response time of a failed request is taken into account with this multiplier applied.

    {10.0}
    

    An actor that listens to HTTP invalidation events

    {<default_invalidator> a <npmd:@comunica/bus-http-invalidate/^4.0.0/components/ActorHttpInvalidateListenable.jsonld#ActorHttpInvalidateListenable>}
    
    limitByDefault: boolean

    Whether rate limiting should be applied from the first request onwards, instead of waiting for a request to fail. Enabling this behaviour can help avoid spamming a server with large amounts of requests when execution begins.

    {false}
    
    mediatorHttp: MediatorHttp

    The HTTP mediator.

    name: string

    The name for this actor.

    {<rdf:subject>}