Interface Options

fetch options.

interface Options {
    acceptContentType?: readonly number[];
    ca?: CongestionAvoidance;
    cOpts?: ConsumerOptions;
    describe?: string;
    estimatedFinalSegNum?: number;
    fw?: Forwarder;
    lifetimeAfterRto?: number;
    modifyInterest?: Modify;
    retxLimit?: number;
    rtte?: RttEstimator | Partial<Parameters>;
    segmentNumConvention?: SegmentConvention;
    segmentRange?: [number, undefined | number];
    signal?: AbortSignal;
    verifier?: Verifier;
}

Hierarchy

  • UnverifiedFetcherOptions
    • Options

    Properties

    acceptContentType? ca? cOpts? describe? estimatedFinalSegNum? fw? lifetimeAfterRto? modifyInterest? retxLimit? rtte? segmentNumConvention? segmentRange? signal? verifier?

    Properties

    OptionalacceptContentType

    acceptContentType?: readonly number[]

    List of acceptable ContentType values.

    Default Value

    [0]

    Optionalca

    ca?: CongestionAvoidance

    Use given congestion avoidance instance.

    OptionalcOpts

    cOpts?: ConsumerOptions

    Inherit fetcher options from consumer options.

    Remarks

    These options are inherited if the corresponding fetcher option is unset:

    • describe
    • fw
    • modifyInterest
    • signal
    • verifier

    Other options cannot be inherited, notably:

    • retx

    Optionaldescribe

    describe?: string

    FwFace description.

    Default Value

    "fetch" + name

    Optional AlphaestimatedFinalSegNum

    estimatedFinalSegNum?: number

    Estimated final segment number (inclusive).

    Remarks

    This option has no effect at the moment.

    Optionalfw

    fw?: Forwarder

    Use the specified logical forwarder.

    Default Value

    Forwarder.getDefault()

    OptionallifetimeAfterRto

    lifetimeAfterRto?: number

    InterestLifetime added to RTO.

    Default Value

    1000ms

    OptionalmodifyInterest

    modifyInterest?: Modify

    Modify Interest according to specified options.

    Remarks

    This can also be used to witness Interests without modification.

    OptionalretxLimit

    retxLimit?: number

    Maximum number of retransmissions, excluding initial Interest.

    Default Value

    15

    Optionalrtte

    rtte?: RttEstimator | Partial<Parameters>

    Use given RttEstimator instance or construct RttEstimator from options.

    OptionalsegmentNumConvention

    segmentNumConvention?: SegmentConvention

    Choose a segment number naming convention.

    Default Value

    Segment3

    OptionalsegmentRange

    segmentRange?: [number, undefined | number]

    Specify segment number range as [begin, end).

    Remarks

    The begin segment number is inclusive and the end segment number is exclusive. If the begin segment number is greater than the final segment number, fetching will fail. If the end segment number is undefined or greater than the final segment number, fetching will stop at the final segment.

    Optionalsignal

    signal?: AbortSignal

    AbortSignal that allows canceling the fetch via AbortController.

    Optionalverifier

    verifier?: Verifier

    Data verifier.

    Default Value

    noopSigning

    Settings

    Member Visibility

    On This Page

    Properties