Interface Options

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

Properties

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

Properties

Optional cpOpts

cpOpts?: ConsumerOptions & ProducerOptions

Consumer and producer options.

Remarks

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

Optional describe

describe?: string

Description for debugging purpose.

Default Value

FullSync + syncPrefix

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cpOpts.

p

p: PSyncFull.Parameters

Algorithm parameters.

Remarks

They must be the same on every peer.

Optional producerBufferLimit

producerBufferLimit?: number

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

Default Value

32

Optional signer

signer?: Signer

Signer of sync reply Data packets.

Default Value

digestSigning

Optional syncInterestInterval

syncInterestInterval?: IntervalRange

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

Default Value

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

Optional syncInterestLifetime

syncInterestLifetime?: number

Sync Interest lifetime in milliseconds.

Default Value

1000

syncPrefix

syncPrefix: Name

Sync group prefix.

Optional syncReplyFreshness

syncReplyFreshness?: number

FreshnessPeriod of sync reply Data packet.

Default Value

1000

Optional verifier

verifier?: Verifier

Verifier of sync reply Data packets.

Default Value

no verification

Settings

Member Visibility

Theme

On This Page

cpOptsdescribeendpointpproducerBufferLimitsignersyncInterestIntervalsyncInterestLifetimesyncPrefixsyncReplyFreshnessverifier