Interface Options

SvSync.create options.

interface Options {
    describe?: string;
    fw?: Forwarder;
    initialize?: ((sync: SvSync) => Promisable<void>);
    initialStateVector?: StateVector;
    periodicTimeout?: number | [median: number, jitter: number];
    signer?: Signer;
    steadyTimer?: [median: number, jitter: number];
    suppressionPeriod?: number;
    suppressionTimeout?: (() => number);
    suppressionTimer?: [median: number, jitter: number];
    svs2interest?: boolean;
    svs2suppression?: boolean;
    syncInterestLifetime?: number;
    syncPrefix: Name;
    verifier?: Verifier;
}

Properties

describe? fw? initialize? initialStateVector? periodicTimeout? signer? steadyTimer? suppressionPeriod? suppressionTimeout? suppressionTimer? svs2interest? svs2suppression? syncInterestLifetime? syncPrefix verifier?

Properties

Optionaldescribe

describe?: string

Description for debugging purpose.

Optionalfw

fw?: Forwarder

Use the specified logical forwarder.

Default Value

Forwarder.getDefault()

Optionalinitialize

initialize?: ((sync: SvSync) => Promisable<void>)

Application initialization function.

Remarks

During initialization, it's possible to remove SyncNode or decrease seqNum. Calling sync.close() has no effect.

Sync protocol starts running after the returned Promise is resolved.

OptionalinitialStateVector

initialStateVector?: StateVector

Initial state vector.

Default Value

empty state vector

Optional ExperimentalperiodicTimeout

periodicTimeout?: number | [median: number, jitter: number]

Sync Interest timer in steady state (SVS v2).

Default Value

[30000ms, ±10%]

Remarks

If specified as tuple,

  • median: median interval in milliseconds.
  • jitter: ± percentage, in [0.0, 1.0) range.

If specified as number, it's interpreted as median.

SVS v1 steadyTimer and SVS v2 periodicTimeout are equivalent. If both are specified, this option takes precedence.

Optionalsigner

signer?: Signer

Sync Interest signer.

Default Value

nullSigner

OptionalsteadyTimer

steadyTimer?: [median: number, jitter: number]

Sync Interest timer in steady state (SVS v1).

Default Value

[30000ms, ±10%]

Remarks

  • median: median interval in milliseconds.
  • jitter: ± percentage, in [0.0, 1.0) range.

Optional ExperimentalsuppressionPeriod

suppressionPeriod?: number

Sync Interest timer in suppression state, maximum value (SVS v2).

Default Value

200ms

OptionalsuppressionTimeout

suppressionTimeout?: (() => number)

Sync Interest timer in suppression state, value generator (SVS v2).

Default Value

SvSync.suppressionExpDelay(suppressionPeriod)

Remarks

The maximum value returned by the generator function should be suppressionPeriod.

This option takes effect only if .svs2suppression is true.

OptionalsuppressionTimer

suppressionTimer?: [median: number, jitter: number]

Sync Interest timer in suppression state (SVS v1).

Default Value

[200ms, ±50%]

Remarks

  • median: median interval in milliseconds.
  • jitter: ± percentage, in [0.0, 1.0) range.

This option takes effect only if .svs2suppression is false.

Optional Experimentalsvs2interest

svs2interest?: boolean

Encode sync Interest in SVS v2 format.

Default Value

false

Optional Experimentalsvs2suppression

svs2suppression?: boolean

Use SVS v2 suppression timer and suppression logic.

Default Value

false

OptionalsyncInterestLifetime

syncInterestLifetime?: number

Sync Interest lifetime in milliseconds.

Default Value

1000

syncPrefix

syncPrefix: Name

Sync group prefix.

Optionalverifier

verifier?: Verifier

Sync Interest verifier.

Default Value

no verification

Settings

Member Visibility

On This Page

Properties