Interface Parameters

Algorithm parameters.

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

Hierarchy

  • Parameters
  • Parameters
    • Parameters

Properties

contentCompression decodeBloom decodeState encodeBloom encodeBloomLength encodeState iblt ibltCompression joinPrefixSeqNum 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) => 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)

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.

threshold

threshold: number

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

toBloomKey

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

Convert a name prefix to a Bloom filter key.

Settings

Member Visibility

On This Page

Properties