Interface ClientOptions

Client options.

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

Hierarchy (view full)

Properties

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

Properties

Optional acceptContentType

acceptContentType?: readonly number[]

List of acceptable ContentType values.

Default Value

[0]

Optional cOpts

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

Optional ca

ca?: CongestionAvoidance

Use given congestion avoidance instance.

Optional describe

describe?: string

Description for debugging purpose.

Default Value

"consume" + Interest name.

Optional endpoint

endpoint?: Endpoint

Inherit fetcher options from Endpoint consumer options.

Deprecated

Specify .cOpts.

Optional estimatedFinalSegNum

estimatedFinalSegNum?: number

Estimated final segment number (inclusive).

Remarks

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 fw

fw?: Forwarder

Logical forwarder instance.

Default Value

Forwarder.getDefault()

Optional lifetimeAfterRto

lifetimeAfterRto?: number

InterestLifetime added to RTO.

Default Value

1000ms

Optional modifyInterest

modifyInterest?: Modify

Modify Interest according to specified options.

Default Value

undefined, no modification.

Optional retx

retx?: RetxPolicy

Retransmission policy.

Default Value

undefined, no retransmission.

Optional retxLimit

retxLimit?: number

Maximum number of retransmissions, excluding initial Interest.

Default Value

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 Value

Segment3

Optional segmentRange

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.

Optional signal

signal?: AbortSignal

AbortSignal that allows canceling the Interest via AbortController.

Optional verifier

verifier?: Verifier

Data verifier.

Default Value

undefined, no verification.

Settings

Member Visibility

Theme

On This Page

acceptContentTypecOptscadescribeendpointestimatedFinalSegNumfwlifetimeAfterRtomodifyInterestretxretxLimitrttesegmentNumConventionsegmentRangesignalverifier