NDNts

    Interface Options

    interface Options {
        bufferAhead?: number;
        bufferBehind?: number;
        contentType?: number;
        freshnessPeriod?: number;
        pOpts?: ProducerOptions;
        producerPrefix?: Name;
        segmentNumConvention?: SegmentConvention;
        signer?: Signer;
        version?: number | ComponentLike;
        versionConvention?: VersionConventionFromNumber;
    }

    Hierarchy (View Summary, Expand)

    Index

    Properties

    bufferAhead? bufferBehind? contentType? freshnessPeriod? pOpts? producerPrefix? segmentNumConvention? signer? version? versionConvention?

    Properties

    bufferAhead?: number

    How many chunks ahead of latest request to store in buffer.

    16

    This is ignored if the ChunkSource supports getChunk() function.

    A larger number can reduce latency of fulfilling Interests if ChunkSource is slow. A smaller number reduces memory usage.

    bufferBehind?: number

    How many chunks behind latest request to store in buffer.

    Infinity

    This is ignored if the ChunkSource supports getChunk() function.

    After processing an Interest requesting segment i, subsequent Interests requesting segment before i - bufferBehind cannot be answered.

    A larger number or even Infinity allows answering Interests requesting early segments, at the cost of buffering many generated packets in memory. A smaller number reduces memory usage, at the risk of not being able to answer some Interests, which would become a problem in the presence of multiple consumers.

    contentType?: number

    Data ContentType.

    0

    freshnessPeriod?: number

    Data FreshnessPeriod (in milliseconds).

    60000

    pOpts?: ProducerOptions

    Producer options.

    • .describe defaults to "serve" + Data prefix.
    • .concurrency defaults to 16.
    • .announcement defaults to producerPrefix.
    • DataProducer.Options.signer defaults to .dataSigner.
    producerPrefix?: Name

    Producer name prefix.

    Data prefix.

    Specifying a shorter prefix enables name discovery.

    segmentNumConvention?: SegmentConvention

    Choose a segment number naming convention.

    Segment3

    signer?: Signer

    Data signer.

    digestSigning

    version?: number | ComponentLike

    Version component or version number.

    Date.now())

    versionConvention?: VersionConventionFromNumber

    Choose a version number naming convention.

    Version3

    If .version is a number, it's encoded with this convention.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR