Interface Options

interface Options {
    cOpts?: ConsumerOptions;
    endpoint?: Endpoint;
    innerVerifier?: Verifier;
    mappingBatch?: number;
    mappingEntryType?: SvMappingEntry.Constructor<SvMappingEntry>;
    mappingVerifier?: Verifier;
    mustFilterByMapping?: boolean;
    outerVerifier?: Verifier;
    retxLimit?: number;
    sync: SvSync;
}

Properties

cOpts? endpoint? innerVerifier? mappingBatch? mappingEntryType? mappingVerifier? mustFilterByMapping? outerVerifier? retxLimit? sync

Properties

Optional cOpts

cOpts?: ConsumerOptions

Consumer options.

Remarks

  • .describe is overridden as "SVS-PS" + prefix.
  • .retx defaults to Options.retxLimit.
  • .signal and .verifier are overridden.

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cOpts.

Optional innerVerifier

innerVerifier?: Verifier

Inner Data verifier.

Default Value

no verification

Optional mappingBatch

mappingBatch?: number

Maximum quantity of MappingEntries to retrieve in a single query.

Default Value

10.

See

https://github.com/named-data/ndn-svs/blob/e39538ed1ddd789de9a34c242af47c3ba4f3583d/ndn-svs/svspubsub.cpp#L199

Optional mappingEntryType

mappingEntryType?: SvMappingEntry.Constructor<SvMappingEntry>

MappingEntry constructor.

Default Value

MappingEntry base type

Optional mappingVerifier

mappingVerifier?: Verifier

Mapping Data verifier.

Default Value

no verification

Optional mustFilterByMapping

mustFilterByMapping?: boolean

If true, force the retrieval of MappingData.

Remarks

When an update matches a SubscribePublisher, by default the MappingData is not retrieved. Since the filter functions in SubscribePrefixFilter depend on MappingEntry, they are not called, and each SubscribePrefixFilter is treated like a SubscribePrefix, which would receive the message if the topic prefix matches. Set this option to true forces the retrieval of MappingData and ensures filter functions are called.

Optional outerVerifier

outerVerifier?: Verifier

Outer Data verifier.

Default Value

no verification

Optional retxLimit

retxLimit?: number

Retransmission limit for Data retrieval.

Default Value

2

sync

sync: SvSync

SvSync instance.

See

SvPublisher.Options.sync regarding reuse

Settings

Member Visibility

Theme

On This Page

cOptsendpointinnerVerifiermappingBatchmappingEntryTypemappingVerifiermustFilterByMappingouterVerifierretxLimitsync