Interface Options

interface Options {
    cOpts?: ConsumerOptions;
    cacheCleanupInterval?: number;
    endpoint?: Endpoint;
    interestLifetime?: number;
    negativeTtl?: number;
    owner?: object;
    positiveTtl?: number;
    retx?: RetxPolicy;
}

Hierarchy (view full)

Properties

cOpts? cacheCleanupInterval? endpoint? interestLifetime? negativeTtl? owner? positiveTtl? retx?

Properties

Optional cOpts

cOpts?: ConsumerOptions

Consumer options.

Remarks

  • .describe defaults to "CertFetcher".

Optional cacheCleanupInterval

cacheCleanupInterval?: number

Cache cleanup interval, in milliseconds.

Default Value

5 minutes

Remarks

This determines how often expired cache entries are deleted.

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cOpts.

Optional interestLifetime

interestLifetime?: number

InterestLifetime for certificate retrieval.

Remarks

If specified, .cOpts.modifyInterest is overridden.

Optional negativeTtl

negativeTtl?: number

Cache lifetime for unsuccessful retrieval, in milliseconds.

Default Value

10 seconds

Remarks

During this period, report the certificate as un-retrievable instead of re-fetching.

Optional owner

owner?: object

Cache instance owner as WeakMap key.

Default Value

.endpoint ?? .cOpts.fw ?? Forwarder.getDefault()

Remarks

CertFetchers with the same .owner share the same cache instance. Cache options are determined when it's first created.

Optional positiveTtl

positiveTtl?: number

Cache lifetime for successful retrieval, in milliseconds.

Default Value

1 hour

Remarks

During this period, return the same certificate instead of re-fetching.

Optional retx

retx?: RetxPolicy

RetxPolicy for certificate retrieval.

Deprecated

Specify in .cOpts.retx.

Settings

Member Visibility

Theme

On This Page

cOptscacheCleanupIntervalendpointinterestLifetimenegativeTtlownerpositiveTtlretx