interface Options {
    announcement?: FwFace.RouteAnnouncement;
    bufferAhead?: number;
    bufferBehind?: number;
    contentType?: number;
    describe?: string;
    endpoint?: Endpoint;
    freshnessPeriod?: number;
    pOpts?: ProducerOptions;
    producerPrefix?: Name;
    segmentNumConvention?: SegmentConvention;
    signer?: Signer;
}

Hierarchy (view full)

Properties

announcement?: FwFace.RouteAnnouncement

Prefix announcement, or false to disable announcement.

Deprecated

Specify in .pOpts.announcement.

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.

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.

contentType?: number

Data ContentType.

Default Value

0
describe?: string

FwFace description.

Deprecated

Specify in .pOpts.describe.

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .pOpts.

freshnessPeriod?: number

Data FreshnessPeriod (in milliseconds).

Default Value

60000

Producer options.

Remarks

  • .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.

Default Value

Data prefix.

Remarks

Specifying a shorter prefix enables name discovery.

segmentNumConvention?: SegmentConvention

Choose a segment number naming convention.

Default Value

Segment3

signer?: Signer

Data signer.

Default Value

digestSigning