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 full)

Properties

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

Properties

OptionalbufferAhead

bufferAhead?: number

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

Default Value

16

Remarks

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.

OptionalbufferBehind

bufferBehind?: number

How many chunks behind latest request to store in buffer.

Default Value

Infinity

Remarks

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.

OptionalcontentType

contentType?: number

Data ContentType.

Default Value

0

OptionalfreshnessPeriod

freshnessPeriod?: number

Data FreshnessPeriod (in milliseconds).

Default Value

60000

OptionalpOpts

pOpts?: ProducerOptions

Producer options.

Remarks

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

OptionalproducerPrefix

producerPrefix?: Name

Producer name prefix.

Default Value

Data prefix.

Remarks

Specifying a shorter prefix enables name discovery.

OptionalsegmentNumConvention

segmentNumConvention?: SegmentConvention

Choose a segment number naming convention.

Default Value

Segment3

Optionalsigner

signer?: Signer

Data signer.

Default Value

digestSigning

Optionalversion

version?: number | ComponentLike

Version component or version number.

Default Value

Date.now())

OptionalversionConvention

versionConvention?: VersionConventionFromNumber

Choose a version number naming convention.

Default Value

Version3

Remarks

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

Settings

Member Visibility

On This Page

Properties