Interface Options

interface Options {
    cpOpts?: ConsumerOptions & ProducerOptions;
    describe?: string;
    p: FullSync.Parameters;
    producerBufferLimit?: number;
    signer?: Signer;
    syncInterestInterval?: IntervalRange;
    syncInterestLifetime?: number;
    syncPrefix: Name;
    syncReplyFreshness?: number;
    verifier?: Verifier;
}

Properties

cpOpts? describe? p producerBufferLimit? signer? syncInterestInterval? syncInterestLifetime? syncPrefix syncReplyFreshness? verifier?

Properties

OptionalcpOpts

cpOpts?: ConsumerOptions & ProducerOptions

Consumer and producer options.

Remarks

  • .fw may be specified.
  • Most other fields are overridden.

Optionaldescribe

describe?: string

Description for debugging purpose.

Default Value

FullSync + syncPrefix

p

p: FullSync.Parameters

Algorithm parameters.

Remarks

They must be the same on every peer.

OptionalproducerBufferLimit

producerBufferLimit?: number

How many sync reply segmented objects to keep in buffer. This must be a positive integer.

Default Value

32

Optionalsigner

signer?: Signer

Signer of sync reply Data packets.

Default Value

digestSigning

OptionalsyncInterestInterval

syncInterestInterval?: IntervalRange

Interval between sync Interests, randomized within the range, in milliseconds.

Default Value

[syncInterestLifetime/2+100,syncInterestLifetime/2+500]

OptionalsyncInterestLifetime

syncInterestLifetime?: number

Sync Interest lifetime in milliseconds.

Default Value

1000

syncPrefix

syncPrefix: Name

Sync group prefix.

OptionalsyncReplyFreshness

syncReplyFreshness?: number

FreshnessPeriod of sync reply Data packet.

Default Value

1000

Optionalverifier

verifier?: Verifier

Verifier of sync reply Data packets.

Default Value

no verification

Settings

Member Visibility

On This Page

Properties