diff --git a/index.html b/index.html index a0753bae..f84937b8 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - libp2p 0.28.0-rc.0 | Documentation + libp2p 0.28.0 | Documentation @@ -15,7 +15,7 @@

libp2p

-
0.28.0-rc.0
+
0.28.0
-
  • - KeyBook - ▸ - - - - -
    • - -
  • @@ -1467,6 +1427,46 @@ +
    • + + + + +
  • + KeyBook + ▸ + + +
    • @@ -1861,7 +1861,7 @@ - + src/index.js @@ -1930,7 +1930,7 @@
    - + src/index.js @@ -2020,7 +2020,7 @@ instance if one is not provided in options.

    - + src/index.js @@ -2108,7 +2108,7 @@ if there is a handler. If not, errors will be logged.

    - + src/index.js @@ -2174,7 +2174,7 @@ if there is a handler. If not, errors will be logged.

    - + src/index.js @@ -2240,7 +2240,7 @@ if there is a handler. If not, errors will be logged.

    - + src/index.js @@ -2307,7 +2307,7 @@ Imports the private key as 'self', if needed.

    - + src/index.js @@ -2374,7 +2374,7 @@ Imports the private key as 'self', if needed.

    - + src/index.js @@ -2487,7 +2487,7 @@ peer will be added to the nodes peerStore

    - + src/index.js @@ -2609,7 +2609,7 @@ and the Connection will be returned

    - + src/index.js @@ -2677,7 +2677,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

    - + src/index.js @@ -2757,7 +2757,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

    - + src/index.js @@ -2837,7 +2837,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

    - + src/index.js @@ -2916,7 +2916,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

    - + src/index.js @@ -2996,7 +2996,7 @@ will no longer be supported on streams.

    - + src/peer-routing.js @@ -3105,7 +3105,7 @@ will no longer be supported on streams.

    - + src/content-routing.js @@ -3224,7 +3224,7 @@ Once a content router succeeds, iteration will stop.

    - + src/content-routing.js @@ -3301,7 +3301,7 @@ a provider of the given key.

    - + src/content-routing.js @@ -3418,7 +3418,7 @@ a provider of the given key.

    - + src/content-routing.js @@ -3528,7 +3528,7 @@ Times out after 1 minute by default.

    - + src/content-routing.js @@ -3645,7 +3645,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -3729,7 +3729,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -3805,7 +3805,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -3888,7 +3888,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -3950,7 +3950,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -4025,7 +4025,7 @@ Times out after 1 minute by default.

    - + src/get-peer.js @@ -4109,7 +4109,7 @@ If a multiaddr is received, the addressBook is updated.

    - + src/address-manager/index.js @@ -4233,7 +4233,7 @@ address adverstising to other peers in the network.

    - + src/address-manager/index.js @@ -4299,7 +4299,7 @@ address adverstising to other peers in the network.

    - + src/address-manager/index.js @@ -4365,7 +4365,7 @@ address adverstising to other peers in the network.

    - + src/address-manager/index.js @@ -4439,7 +4439,7 @@ address adverstising to other peers in the network.

    - + src/connection-manager/index.js @@ -4519,7 +4519,7 @@ address adverstising to other peers in the network.

    - + src/connection-manager/index.js @@ -4582,7 +4582,7 @@ address adverstising to other peers in the network.

    - + src/connection-manager/index.js @@ -4645,7 +4645,7 @@ address adverstising to other peers in the network.

    - + src/connection-manager/index.js @@ -4703,7 +4703,7 @@ address adverstising to other peers in the network.

    - + src/connection-manager/index.js @@ -4762,7 +4762,7 @@ only event loop and connection limits will be monitored.

    - + src/connection-manager/index.js @@ -4820,7 +4820,7 @@ only event loop and connection limits will be monitored.

    - + src/connection-manager/index.js @@ -4878,7 +4878,7 @@ only event loop and connection limits will be monitored.

    - + src/connection-manager/index.js @@ -4959,7 +4959,7 @@ will be disconnected first.

    - + src/connection-manager/index.js @@ -5030,7 +5030,7 @@ will be disconnected first.

    - + src/connection-manager/index.js @@ -5101,7 +5101,7 @@ will be disconnected first.

    - + src/connection-manager/index.js @@ -5188,7 +5188,7 @@ will be disconnected first.

    - + src/connection-manager/latency-monitor.js @@ -5242,7 +5242,7 @@ will be disconnected first.

    - + src/connection-manager/latency-monitor.js @@ -5340,7 +5340,7 @@ will be disconnected first.

    - + src/connection-manager/latency-monitor.js @@ -5515,7 +5515,7 @@ monitor.on('data', (summary) => - + src/connection-manager/latency-monitor.js @@ -5590,7 +5590,7 @@ it will not count for this time period

    - + src/connection-manager/visibility-change-emitter.js @@ -5644,7 +5644,7 @@ it will not count for this time period

    - + src/connection-manager/visibility-change-emitter.js @@ -5718,7 +5718,7 @@ it will not count for this time period

    - + src/connection-manager/visibility-change-emitter.js @@ -5781,7 +5781,7 @@ it will not count for this time period

    - + src/circuit/index.js @@ -5880,7 +5880,7 @@ it will not count for this time period

    - + src/circuit/index.js @@ -5990,7 +5990,7 @@ it will not count for this time period

    - + src/circuit/index.js @@ -6073,7 +6073,7 @@ it will not count for this time period

    - + src/circuit/index.js @@ -6148,7 +6148,7 @@ it will not count for this time period

    - + src/circuit/index.js @@ -6202,7 +6202,7 @@ it will not count for this time period

    - + src/identify/index.js @@ -6270,7 +6270,7 @@ it will not count for this time period

    - + src/circuit/listener.js @@ -6340,7 +6340,7 @@ it will not count for this time period

    - + src/circuit/listener.js @@ -6419,7 +6419,7 @@ it will not count for this time period

    - + src/circuit/listener.js @@ -6485,7 +6485,7 @@ it will not count for this time period

    - + src/circuit/listener.js @@ -6570,7 +6570,7 @@ be dialed over TCP rather than any other transport

    - + src/circuit/circuit/hop.js @@ -6687,7 +6687,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6762,7 +6762,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6838,7 +6838,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6941,7 +6941,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7003,7 +7003,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7071,7 +7071,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7133,7 +7133,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7195,7 +7195,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7383,7 +7383,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7437,7 +7437,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7549,7 +7549,7 @@ will be used.

    - + src/dialer/index.js @@ -7632,7 +7632,7 @@ will be used.

    - + src/dialer/index.js @@ -7735,7 +7735,7 @@ will be used.

    - + src/dialer/dial-request.js @@ -7846,7 +7846,7 @@ all other dials in the request will be cancelled.

    - + src/dialer/dial-request.js @@ -7945,7 +7945,7 @@ all other dials in the request will be cancelled.

    - + src/keychain/index.js @@ -8023,7 +8023,7 @@ all other dials in the request will be cancelled.

    - + src/keychain/index.js @@ -8101,7 +8101,7 @@ all other dials in the request will be cancelled.

    - + src/keychain/index.js @@ -8167,7 +8167,7 @@ all other dials in the request will be cancelled.

    - + src/keychain/index.js @@ -8242,7 +8242,7 @@ The default options for a keychain.

    - + src/keychain/index.js @@ -8312,7 +8312,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8410,7 +8410,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8476,7 +8476,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8556,7 +8556,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8636,7 +8636,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8716,7 +8716,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8805,7 +8805,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -8894,7 +8894,7 @@ arbitrary message content.

    - + src/keychain/index.js @@ -9000,7 +9000,7 @@ arbitrary message content.

    - + src/keychain/cms.js @@ -9070,7 +9070,7 @@ arbitrary message content.

    - + src/keychain/cms.js @@ -9160,7 +9160,7 @@ arbitrary message content.

    - + src/keychain/cms.js @@ -9250,7 +9250,7 @@ exists, an Error is returned with the property 'missingKeys'. It is array of ke - + src/keychain/util.js @@ -9337,7 +9337,7 @@ exists, an Error is returned with the property 'missingKeys'. It is array of ke - + src/keychain/util.js @@ -9416,7 +9416,7 @@ resolve to either true or false.

    - + src/metrics/index.js @@ -9538,7 +9538,7 @@ resolve to either true or false.

    - + src/metrics/index.js @@ -9593,7 +9593,7 @@ will be ignored.

    - + src/metrics/index.js @@ -9648,7 +9648,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9710,7 +9710,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9772,7 +9772,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9848,7 +9848,7 @@ is a live peer, or in the disconnected peer LRU cache.

    - + src/metrics/index.js @@ -9910,7 +9910,7 @@ is a live peer, or in the disconnected peer LRU cache.

    - + src/metrics/index.js @@ -9985,7 +9985,7 @@ is a live peer, or in the disconnected peer LRU cache.

    - + src/metrics/index.js @@ -10054,7 +10054,7 @@ be stopped and moved to an LRU for temporary retention.

    - + src/metrics/index.js @@ -10132,7 +10132,7 @@ placeholder stats will be merged with the existing stats.

    - + src/metrics/index.js @@ -10262,7 +10262,7 @@ with the placeholder string returned from here, and the known PeerId - + src/metrics/index.js @@ -10346,7 +10346,7 @@ and returned.

    - + src/metrics/old-peers.js @@ -10421,7 +10421,7 @@ and returned.

    - + src/metrics/stats.js @@ -10501,7 +10501,7 @@ and returned.

    - + src/metrics/stats.js @@ -10569,7 +10569,7 @@ should only need to be called if Stats.stop was previously called,
    - + src/metrics/stats.js @@ -10636,7 +10636,7 @@ timer.

    - + src/metrics/stats.js @@ -10702,7 +10702,7 @@ timer.

    - + src/metrics/stats.js @@ -10768,7 +10768,7 @@ timer.

    - + src/metrics/stats.js @@ -10834,7 +10834,7 @@ timer.

    - + src/metrics/stats.js @@ -10930,7 +10930,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11041,7 +11041,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11134,7 +11134,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11188,7 +11188,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11271,7 +11271,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11333,7 +11333,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11395,7 +11395,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11470,7 +11470,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11524,7 +11524,7 @@ current Timestamp, then resets the update timer.

    - + src/transport-manager.js @@ -11592,7 +11592,7 @@ If a transport has any running listeners, they will be closed.

    - + src/transport-manager.js @@ -11647,7 +11647,7 @@ If any listeners are running, they will be closed.

    - + src/transport-manager.js @@ -11708,7 +11708,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/upgrader.js @@ -11869,7 +11869,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/upgrader.js @@ -11948,7 +11948,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/upgrader.js @@ -12035,7 +12035,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/upgrader.js @@ -12199,7 +12199,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/upgrader.js @@ -12278,7 +12278,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/upgrader.js @@ -12365,7 +12365,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12424,7 +12424,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12482,7 +12482,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12540,7 +12540,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12598,7 +12598,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12656,7 +12656,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12714,7 +12714,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12772,7 +12772,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12838,7 +12838,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -12917,7 +12917,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/index.js @@ -13004,7 +13004,7 @@ NO_FATAL should be used for not failing when not listening.

    - + src/peer-store/address-book.js @@ -13077,7 +13077,7 @@ of a peer.

    - + src/peer-store/address-book.js @@ -13140,7 +13140,7 @@ of a peer.

    - + src/peer-store/address-book.js @@ -13227,7 +13227,7 @@ of a peer.

    - + src/peer-store/address-book.js @@ -13315,7 +13315,7 @@ If the peer is not known, it is set with the given addresses.

    - + src/peer-store/address-book.js @@ -13403,7 +13403,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/address-book.js @@ -13459,7 +13459,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/proto-book.js @@ -13493,315 +13493,6 @@ will include the encapsulated PeerId of the peer.

    - - - - - - - - - - - -
    - - -
    - -

    - KeyBook -

    - - - - src/peer-store/key-book.js - - -
    - - -

    The KeyBook is responsible for keeping the known public keys of a peer.

    - -
    new KeyBook(peerStore: PeerStore)
    - - -

    - Extends - - Book - -

    - - - - - - - - - - -
    Parameters
    -
    - -
    -
    - peerStore (PeerStore) - -
    - -
    - -
    - - - - - - - - - - - - - - - -
    Instance Members
    -
    - -
    -
    -
    - ▸ - data -
    -
    - -
    - -
    -
    -
    - ▸ - set(peerId, publicKey) -
    -
    - -
    - -
    -
    -
    - ▸ - get(peerId) -
    -
    - -
    - -
    @@ -13823,7 +13514,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/book.js @@ -13946,7 +13637,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/book.js @@ -14004,7 +13695,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/book.js @@ -14083,7 +13774,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/book.js @@ -14162,7 +13853,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/book.js @@ -14222,6 +13913,315 @@ will include the encapsulated PeerId of the peer.

    +
    + +
    +
    + +
    + + + + + + + + + + + +
    + + +
    + +

    + KeyBook +

    + + + + src/peer-store/key-book.js + + +
    + + +

    The KeyBook is responsible for keeping the known public keys of a peer.

    + +
    new KeyBook(peerStore: PeerStore)
    + + +

    + Extends + + Book + +

    + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + peerStore (PeerStore) + +
    + +
    + +
    + + + + + + + + + + + + + + + +
    Instance Members
    +
    + +
    +
    +
    + ▸ + data +
    +
    + +
    + +
    +
    +
    + ▸ + set(peerId, publicKey) +
    +
    + +
    + +
    +
    +
    + ▸ + get(peerId) +
    +
    + @@ -14249,7 +14249,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/metadata-book.js @@ -14322,7 +14322,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14385,7 +14385,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14482,7 +14482,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14604,7 +14604,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14683,7 +14683,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14770,7 +14770,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14849,7 +14849,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14944,7 +14944,7 @@ protocols of a peer.

    - + src/peer-store/metadata-book.js @@ -14999,7 +14999,7 @@ protocols of a peer.

    - + src/peer-store/proto-book.js @@ -15072,7 +15072,7 @@ protocols of a peer.

    - + src/peer-store/proto-book.js @@ -15135,7 +15135,7 @@ protocols of a peer.

    - + src/peer-store/proto-book.js @@ -15223,7 +15223,7 @@ If the peer was not known before, it will be added.

    - + src/peer-store/proto-book.js @@ -15319,7 +15319,7 @@ If the peer was not known before, it will be added.

    - + src/peer-store/persistent/index.js @@ -15433,7 +15433,7 @@ If the peer was not known before, it will be added.

    - + src/peer-store/persistent/index.js @@ -15491,7 +15491,7 @@ If the peer was not known before, it will be added.

    - + src/peer-store/persistent/index.js @@ -15549,7 +15549,7 @@ If the peer was not known before, it will be added.

    - + src/peer-store/persistent/index.js @@ -15612,7 +15612,7 @@ If the peer was not known before, it will be added.

    - + src/peer-store/persistent/index.js @@ -15686,7 +15686,7 @@ If the peer was not known before, it will be added.

    - + src/registrar.js @@ -15791,7 +15791,7 @@ If the peer was not known before, it will be added.

    - + src/registrar.js @@ -15854,7 +15854,7 @@ If the peer was not known before, it will be added.

    - + src/registrar.js @@ -15933,7 +15933,7 @@ If the peer was not known before, it will be added.

    - + src/registrar.js @@ -16013,7 +16013,7 @@ If the peer was not known before, it will be added.

    - + src/registrar.js @@ -16093,7 +16093,7 @@ If the peer was not known before, it will be added.

    - + src/registrar.js @@ -16188,7 +16188,7 @@ If the peer was not known before, it will be added.

    - + src/ping/index.js @@ -16271,7 +16271,7 @@ If the peer was not known before, it will be added.

    - + src/ping/index.js @@ -16338,7 +16338,7 @@ If the peer was not known before, it will be added.

    - + src/ping/index.js @@ -16405,7 +16405,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16504,7 +16504,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16557,7 +16557,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16610,7 +16610,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16663,7 +16663,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16716,7 +16716,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16791,7 +16791,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16858,7 +16858,7 @@ If the peer was not known before, it will be added.

    - + src/identify/index.js @@ -16935,7 +16935,7 @@ an error will be thrown.

    - + src/identify/index.js @@ -17050,7 +17050,7 @@ an error will be thrown.

    - + src/identify/index.js