Interface Parameters

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

Hierarchy

  • Parameters
  • Parameters
    • Parameters

Properties

contentCompression decodeBloom decodeState encodeBloom encodeBloomLength encodeState iblt ibltCompression joinPrefixSeqNum nUselessCompsAfterIblt threshold toBloomKey

Properties

contentCompression

contentCompression: Compression

Compression method for State in segmented object.

decodeBloom

decodeBloom: ((Bloom, comps) => Promise<BloomFilter>)

Type declaration

    • (Bloom, comps): Promise<BloomFilter>

    • Decode a Bloom filter.

      Parameters

      • Bloom: typeof BloomFilter
      • comps: readonly Component[]

      Returns Promise<BloomFilter>

decodeState

decodeState: ((payload) => State)

Type declaration

    • (payload): State

    • Decode State from buffer (without decompression).

      Parameters

      • payload: Uint8Array

      Returns State

encodeBloom

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

Type declaration

encodeBloomLength

encodeBloomLength: number

Number of name components in an encoded Bloom filter.

encodeState

encodeState: ((state) => Uint8Array)

Type declaration

    • (state): Uint8Array

    • Encode State to buffer (without compression).

      Parameters

      • state: State

      Returns Uint8Array

iblt

iblt: IBLT.Parameters

ibltCompression

ibltCompression: Compression

Compression method for IBLT in name component.

joinPrefixSeqNum

joinPrefixSeqNum: ((ps) => PrefixSeqNumEncoded)

Type declaration

    • (ps): PrefixSeqNumEncoded

    • Encode prefix and sequence number to byte array.

      Parameters

      • ps: PrefixSeqNum

      Returns PrefixSeqNumEncoded

nUselessCompsAfterIblt

nUselessCompsAfterIblt: number

Number of useless components between IBLT and Version.

See

https://github.com/named-data/PSync/blob/b60398c5fc216a1b577b9dbcf61d48a21cb409a4/PSync/full-producer.cpp#L239

threshold

threshold: number

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

toBloomKey

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

Type declaration

    • (prefix): string | Uint8Array

    • Convert a name prefix to a Bloom filter key.

      Parameters

      Returns string | Uint8Array

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc