Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Parameters
  • Parameters
    • Parameters

Index

Properties

bloom

bloom: Parameters

contentCompression

contentCompression: Compression

Compression method for State in segmented object.

encodeBloomLength

encodeBloomLength: number

Number of name components in an encoded Bloom filter.

iblt

ibltCompression

ibltCompression: Compression

Compression method for IBLT in name component.

nUselessCompsAfterIblt

nUselessCompsAfterIblt: number

segmentNumConvention

segmentNumConvention: NamingConvention<number, number>

Segment number convention for SyncData.

threshold

threshold: number

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

versionConvention

versionConvention: NamingConvention<number, number>

Version convention for SyncData.

Methods

decodeBloom

  • decodeBloom(Bloom: typeof BloomFilter, comps: readonly Component[]): Promise<BloomFilter>
  • Decode a Bloom filter.

    Parameters

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

    Returns Promise<BloomFilter>

decodeState

  • decodeState(payload: Uint8Array): State
  • Decode State from buffer (without decompression).

    Parameters

    • payload: Uint8Array

    Returns State

encodeBloom

  • encodeBloom(bf: BloomFilter): Component[]

encodeState

  • encodeState(state: State): Uint8Array
  • Encode State to buffer (without compression).

    Parameters

    • state: State

    Returns Uint8Array

joinPrefixSeqNum

  • joinPrefixSeqNum(ps: PrefixSeqNum): PrefixSeqNumEncoded
  • Encode prefix and sequence number to byte array.

    Parameters

    • ps: PrefixSeqNum

    Returns PrefixSeqNumEncoded

toBloomKey

  • toBloomKey(prefix: Name): string | Uint8Array
  • Convert a name prefix to a Bloom filter key.

    Parameters

    • prefix: Name

    Returns string | Uint8Array

Generated using TypeDoc