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;
    suppressionPeriod?: number;
    suppressionTimeout?: () => number;
    svs3?: boolean;
    syncInterestLifetime?: number;
    syncPrefix: Name;
    verifier?: Verifier;
}

Properties

describe? fw? initialize? initialStateVector? periodicTimeout? signer? suppressionPeriod? suppressionTimeout? svs3? 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

OptionalperiodicTimeout

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

Sync Interest timer in steady state.

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.

Optionalsigner

signer?: Signer

Sync Interest signer (SVS v2). State Vector Data signer (SVS v3).

Default Value

nullSigner

OptionalsuppressionPeriod

suppressionPeriod?: number

Sync Interest timer in suppression state, maximum value.

Default Value

200ms

OptionalsuppressionTimeout

suppressionTimeout?: () => number

Sync Interest timer in suppression state, value generator.

Default Value

SvSync.suppressionExpDelay(suppressionPeriod)

Remarks

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

Optionalsvs3

svs3?: boolean

Enable SVS v3 protocol.

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 (SVS v2). State Vector Data verifier (SVS v3).

Default Value

no verification

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR