Class PersistentPeerStore

Responsible for managing the persistence of data in the PeerStore.

Hierarchy

Index

References

Constructors

Properties

Accessors

Methods

References

Address

Re-exports Address

PersistentPeerStoreOptions

Re-exports PersistentPeerStoreOptions

PersistentPeerStoreProperties

Re-exports PersistentPeerStoreProperties

Constructors

constructor

  • new PersistentPeerStore(__namedParameters: { datastore: any; peerId: PeerId; threshold: undefined | number }): PersistentPeerStore

Properties

Private _addDirtyPeer

_addDirtyPeer: any

Add modified peer to the dirty set

param
param

Private _addDirtyPeerKey

_addDirtyPeerKey: any

Add modified peer key to the dirty set

param
param

Private _addDirtyPeerMetadata

_addDirtyPeerMetadata: any

Add modified metadata peer to the set.

param
param
param

Private _batchAddressBook

_batchAddressBook: any

Add address book data of the peer to the batch.

param
param

Private _batchKeyBook

_batchKeyBook: any

Add Key book data of the peer to the batch.

param
param

Private _batchMetadataBook

_batchMetadataBook: any

Add metadata book data of the peer to the batch.

param
param

Private _batchProtoBook

_batchProtoBook: any

Add proto book data of the peer to the batch.

param
param

Private _commitData

_commitData: any

Add all the peers current data to a datastore batch and commit it.

returns

_datastore

_datastore: any

Backend datastore used to persist data.

_dirtyMetadata

_dirtyMetadata: Map<string, Set<string>>

Peers metadata changed mapping peer identifers to metadata changed.

_dirtyPeers

_dirtyPeers: Set<any>

Peers modified after the latest data persisted.

_peerId

_peerId: PeerId

Private _processDatastoreEntry

_processDatastoreEntry: any

Process datastore entry and add its data to the correct book.

param
param

datastore key

param

datastore value stored

returns

addressBook

addressBook: AddressBook

AddressBook containing a map of peerIdStr to Address.

keyBook

keyBook: KeyBook

KeyBook containing a map of peerIdStr to their PeerId with public keys.

metadataBook

metadataBook: MetadataBook

MetadataBook containing a map of peerIdStr to their metadata Map.

protoBook

protoBook: ProtoBook

ProtoBook containing a map of peerIdStr to supported protocols.

threshold

threshold: number

Accessors

peers

  • get peers(): Map<string, { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] }>

  • Get all the stored information of every peer known.

    Returns Map<string, { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] }>

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

delete

  • delete(peerId: PeerId): boolean

  • Delete the information of the given peer in every book.

    Parameters

    Returns boolean

    true if found and removed

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

get

  • get(peerId: PeerId): { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] } | undefined

  • Get the stored information of a given peer.

    Parameters

    Returns { addresses: Address[]; id: PeerId; metadata: Map<string, Uint8Array> | undefined; protocols: string[] } | undefined

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

start

  • start(): void

stop

  • stop(): void