NDNts

    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;
    }
    Index

    Properties

    describe? fw? initialize? initialStateVector? periodicTimeout? signer? suppressionPeriod? suppressionTimeout? svs3? syncInterestLifetime? syncPrefix verifier?

    Properties

    describe?: string

    Description for debugging purpose.

    fw?: Forwarder

    Use the specified logical forwarder.

    Forwarder.getDefault()

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

    Application initialization function.

    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.

    initialStateVector?: StateVector

    Initial state vector.

    empty state vector

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

    Sync Interest timer in steady state.

    [30000ms, ±10%]

    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.

    signer?: Signer

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

    nullSigner

    suppressionPeriod?: number

    Sync Interest timer in suppression state, maximum value.

    200ms

    suppressionTimeout?: () => number

    Sync Interest timer in suppression state, value generator.

    SvSync.suppressionExpDelay(suppressionPeriod)

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

    svs3?: boolean

    Enable SVS v3 protocol.

    false

    syncInterestLifetime?: number

    Sync Interest lifetime in milliseconds.

    1000

    syncPrefix: Name

    Sync group prefix.

    verifier?: Verifier

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

    no verification

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR