Interface Parameters

interface Parameters {
    contentCompression: Compression;
    decodeBloom: (
        Bloom: typeof BloomFilter,
        comps: readonly Component[],
    ) => Promise<BloomFilter>;
    decodeState: (payload: Uint8Array<ArrayBufferLike>) => State;
    encodeBloom: (bf: BloomFilter) => Component[];
    encodeBloomLength: number;
    encodeState: (state: State) => Uint8Array<ArrayBufferLike>;
    iblt: IBLT.Parameters;
    ibltCompression: Compression;
    joinPrefixSeqNum: (ps: PrefixSeqNum) => PrefixSeqNumEncoded;
    syncInterestNameCumulativeNElements?: boolean;
    threshold: number;
    toBloomKey: (prefix: Name) => string | Uint8Array<ArrayBufferLike>;
}

Hierarchy

  • Parameters
  • Parameters
    • Parameters

Properties

contentCompression decodeBloom decodeState encodeBloom encodeBloomLength encodeState iblt ibltCompression joinPrefixSeqNum syncInterestNameCumulativeNElements? threshold toBloomKey

Properties

contentCompression

contentCompression: Compression

Compression method for State in segmented object.

decodeBloom

decodeBloom: (
    Bloom: typeof BloomFilter,
    comps: readonly Component[],
) => Promise<BloomFilter>

Decode a Bloom filter.

decodeState

decodeState: (payload: Uint8Array<ArrayBufferLike>) => State

Decode State from buffer (without decompression).

encodeBloom

encodeBloom: (bf: BloomFilter) => Component[]

Encode a Bloom filter.

encodeBloomLength

encodeBloomLength: number

Number of name components in an encoded Bloom filter.

encodeState

encodeState: (state: State) => Uint8Array<ArrayBufferLike>

Encode State to buffer (without compression).

iblt

iblt: IBLT.Parameters

ibltCompression

ibltCompression: Compression

Compression method for IBLT in name component.

joinPrefixSeqNum

joinPrefixSeqNum: (ps: PrefixSeqNum) => PrefixSeqNumEncoded

Encode prefix and sequence number to byte array.

Optional ExperimentalsyncInterestNameCumulativeNElements

syncInterestNameCumulativeNElements?: boolean

If true, sync Interest name contains cumulative number of elements in IBLT.

Default Value

true

Remarks

PSync C++ library commit d83af5255db9c4a557264542647f7ccb281e6840 (2024-04-09) introduced an algorithm change that involves a breaking change in sync Interest encoding. To interact with PSync since this commit, set to true. To interact with PSync before this commit, set to false.

threshold

threshold: number

If IBLT diff has at least this number of entries, respond with SyncData right away.

toBloomKey

toBloomKey: (prefix: Name) => string | Uint8Array<ArrayBufferLike>

Convert a name prefix to a Bloom filter key.

Settings

Member Visibility

On This Page

Properties