Interface Options

interface Options {
    cpOpts?: ConsumerOptions & ProducerOptions;
    describe?: string;
    endpoint?: Endpoint;
    filterPubs?: SyncpsPubsub.FilterPubsCallback;
    isExpired?: SyncpsPubsub.IsExpiredCallback;
    maxClockSkew?: number;
    maxPubLifetime?: number;
    modifyPublication?: SyncpsPubsub.ModifyPublicationCallback;
    p: SyncpsPubsub.Parameters;
    pubSigner?: Signer;
    pubVerifier?: Verifier;
    syncDataPubSize?: number;
    syncInterestLifetime?: number;
    syncPrefix: Name;
    syncSigner?: Signer;
    syncVerifier?: Verifier;
}

Properties

cpOpts? describe? endpoint? filterPubs? isExpired? maxClockSkew? maxPubLifetime? modifyPublication? p pubSigner? pubVerifier? syncDataPubSize? syncInterestLifetime? syncPrefix syncSigner? syncVerifier?

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

SyncpsPubsub + syncPrefix

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cpOpts.

Optional filterPubs

filterPubs?: SyncpsPubsub.FilterPubsCallback

Callback to decide what publications to be included in a response.

Default Value

- Respond nothing if there's no own publication.
- Otherwise, prioritize own publications over others, and prioritize later timestamp.

Optional isExpired

isExpired?: SyncpsPubsub.IsExpiredCallback

Callback to determine if a publication is expired.

Default Value

The last component is interpreted as TimestampNameComponent.
If it is not a TimestampNameComponent, the publication is seen as expired.

Optional maxClockSkew

maxClockSkew?: number

Maximum clock skew, for calculating timers.

Default Value

1000

Optional maxPubLifetime

maxPubLifetime?: number

Publication lifetime.

Default Value

1000

Optional modifyPublication

modifyPublication?: SyncpsPubsub.ModifyPublicationCallback

Callback to modify publication before it's signed.

Default Value

appending a TimestampNameComponent to the name

p

p: SyncpsPubsub.Parameters

Algorithm parameters.

Remarks

They must be the same on every peer.

Optional pubSigner

pubSigner?: Signer

Signer of publications.

Default Value

digestSigning

Optional pubVerifier

pubVerifier?: Verifier

Verifier of publications.

Default Value

no verification

Optional syncDataPubSize

syncDataPubSize?: number

Advisory maximum size for publications included in a sync reply Data packet.

Default Value

1300

Optional syncInterestLifetime

syncInterestLifetime?: number

Sync Interest lifetime in milliseconds.

Default Value

4000

syncPrefix

syncPrefix: Name

Sync group prefix.

Optional syncSigner

syncSigner?: Signer

Signer of sync reply Data packets.

Default Value

digestSigning

Optional syncVerifier

syncVerifier?: Verifier

Verifier of sync reply Data packets.

Default Value

no verification

Settings

Member Visibility

Theme

On This Page

cpOptsdescribeendpointfilterPubsisExpiredmaxClockSkewmaxPubLifetimemodifyPublicationppubSignerpubVerifiersyncDataPubSizesyncInterestLifetimesyncPrefixsyncSignersyncVerifier