Interface Options

Hierarchy

Properties

acceptContentType? ca? conventions? describe? endpoint? estimatedFinalSegNum? expectedSuffixLen? lifetimeAfterRto? modifyInterest? retxLimit? rtte? segmentNumConvention? segmentRange? signal? verifier? versionConvention?

Properties

Optional acceptContentType

acceptContentType?: readonly number[]

List of acceptable ContentType values. Default is [0].

Optional ca

ca?: CongestionAvoidance

Use given congestion avoidance instance.

Optional conventions

conventions?: readonly [VersionConvention, SegmentConvention][]

List of acceptable version+segment naming convention combinations. If this is specified and non-empty, it overrides versionConvention,segmentNumConvention.

Optional describe

describe?: string

FwFace description.

Optional endpoint

endpoint?: Endpoint

Use the specified endpoint instead of the default.

Optional estimatedFinalSegNum

estimatedFinalSegNum?: number

Estimated final segment number (inclusive). If specified, FetchLogic sends Interests up to this segment number initially as permitted by congestion control, then sends further Interests in a stop-and-wait manner, unless a new estimation or known finalSegNum is provided via setFinalSegNum() function.

Optional expectedSuffixLen

expectedSuffixLen?: number | typeof ANY_SUFFIX_LEN

Expected number of suffix components, including Version and Segment. Minimum and default are 2, i.e. Version and Segment components. ANY_SUFFIX_LEN allows any suffix length.

Optional lifetimeAfterRto

lifetimeAfterRto?: number

InterestLifetime added to RTO. Default is 1000ms. Ignored if lifetime is set.

Optional modifyInterest

modifyInterest?: Modify

Modify Interest according to specified options. This can also be used to witness Interests without modification.

Optional retxLimit

retxLimit?: number

Maximum number of retransmissions, excluding initial Interest. Default is 15.

Optional rtte

rtte?: RttEstimator | Partial<Parameters>

Use given RttEstimator instance or construct RttEstimator from options.

Optional segmentNumConvention

segmentNumConvention?: SegmentConvention

Choose a segment number naming convention. Default is Segment from @ndn/naming-convention2 package.

Optional segmentRange

segmentRange?: [number, undefined | number]

Specify segment number range as [begin, end). 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.

Optional signal

signal?: AbortSignal

AbortSignal that allows canceling the Interest via AbortController.

Optional verifier

verifier?: Verifier

If specified, verify received Data.

Optional versionConvention

versionConvention?: VersionConvention

Choose a version naming convention. Default is Version from @ndn/naming-convention2 package.

Settings

Member Visibility

Theme

Generated using TypeDoc