onEventHandlers:{ Â Â Â Â browser:network: (() => void); Â Â Â Â peer:connect: ((evt) => void); Â Â Â Â peer:disconnect: ((evt) => void); Â Â Â Â peer:discovery: ((evt) => void); } = ...
onEventHandlers:{ Â Â Â Â browser:network: (() => void); Â Â Â Â peer:connect: ((evt) => void); Â Â Â Â peer:disconnect: ((evt) => void); Â Â Â Â peer:discovery: ((evt) => void); } = ...
Attempts to establish a connection with a peer and set up specified protocols.
The method handles both PeerId and Multiaddr inputs, manages connection attempts,
and maintains the connection state.
The dialing process includes:
@@ -57,7 +57,7 @@ and maintains the connection state.
Returns Promise<Connection>
Throws
If the multiaddr is missing a peer ID
Throws
If the maximum dial attempts are reached and the peer cannot be dialed
Throws
If there's an error deleting an undialable peer from the peer store
-
Example
// Dial using PeerId awaitconnectionManager.dialPeer(peerId);
// Dial using multiaddr with specific protocols awaitconnectionManager.dialPeer(multiaddr, [ "/vac/waku/relay/2.0.0", "/vac/waku/lightpush/2.0.0-beta1" ]);
+
Example
// Dial using PeerId awaitconnectionManager.dialPeer(peerId);
// Dial using multiaddr with specific protocols awaitconnectionManager.dialPeer(multiaddr, [ "/vac/waku/relay/2.0.0", "/vac/waku/lightpush/2.0.0-beta1" ]);
Remarks
The method implements exponential backoff through multiple dial attempts
@@ -66,20 +66,20 @@ and maintains the connection state.
Updates the peer store and connection state after successful/failed attempts
If all dial attempts fail, triggers DNS discovery as a fallback
-
PrivatedialPeerStorePeers
dialPeerStorePeers(): Promise<void>
Returns Promise<void>
PrivatedispatchDiscoveryEvent
dispatchDiscoveryEvent(peerId): Promise<void>
Parameters
peerId: PeerId
Returns Promise<void>
dispatchEvent
dispatchEvent(event): boolean
Parameters
event: Event
Returns boolean
PrivatedispatchWakuConnectionEvent
dispatchWakuConnectionEvent(): void
Returns void
dropConnection
dropConnection(peerId): Promise<void>
Parameters
peerId: PeerId
Returns Promise<void>
getConnectedPeers
getConnectedPeers(codec?): Promise<Peer[]>
Parameters
Optionalcodec: string
Returns Promise<Peer[]>
PrivategetDialablePeerInfo
getDialablePeerInfo(peer): PeerId | Multiaddr
Internal
Internal utility to extract a PeerId or Multiaddr from a peer input.
+
PrivatedialPeerStorePeers
dialPeerStorePeers(): Promise<void>
Returns Promise<void>
PrivatedispatchDiscoveryEvent
dispatchDiscoveryEvent(peerId): Promise<void>
Parameters
peerId: PeerId
Returns Promise<void>
dispatchEvent
dispatchEvent(event): boolean
Parameters
event: Event
Returns boolean
PrivatedispatchWakuConnectionEvent
dispatchWakuConnectionEvent(): void
Returns void
dropConnection
dropConnection(peerId): Promise<void>
Parameters
peerId: PeerId
Returns Promise<void>
getConnectedPeers
getConnectedPeers(codec?): Promise<Peer[]>
Parameters
Optionalcodec: string
Returns Promise<Peer[]>
PrivategetDialablePeerInfo
getDialablePeerInfo(peer): PeerId | Multiaddr
Internal
Internal utility to extract a PeerId or Multiaddr from a peer input.
This is used internally by the connection manager to handle different peer input formats.
\ No newline at end of file
diff --git a/classes/_waku_core.DecodedMessage.html b/classes/_waku_core.DecodedMessage.html
index 7f4e09b655..3ba823739b 100644
--- a/classes/_waku_core.DecodedMessage.html
+++ b/classes/_waku_core.DecodedMessage.html
@@ -1,4 +1,4 @@
-DecodedMessage | Documentation
\ No newline at end of file
diff --git a/classes/_waku_core.Decoder.html b/classes/_waku_core.Decoder.html
index 837be01963..8db7d7cfb8 100644
--- a/classes/_waku_core.Decoder.html
+++ b/classes/_waku_core.Decoder.html
@@ -1,6 +1,6 @@
-Decoder | Documentation
\ No newline at end of file
diff --git a/classes/_waku_core.Encoder.html b/classes/_waku_core.Encoder.html
index 2409dac00d..1f3454d976 100644
--- a/classes/_waku_core.Encoder.html
+++ b/classes/_waku_core.Encoder.html
@@ -1,8 +1,8 @@
-Encoder | Documentation
\ No newline at end of file
diff --git a/classes/_waku_core.StreamManager.html b/classes/_waku_core.StreamManager.html
index 9055563f85..8fa0058b06 100644
--- a/classes/_waku_core.StreamManager.html
+++ b/classes/_waku_core.StreamManager.html
@@ -1,4 +1,4 @@
-StreamManager | Documentation
new StreamManager(multicodec, getConnections, addEventListener): StreamManager
Parameters
multicodec: string
getConnections: ((peerId?) => Connection[])
(peerId?): Connection[]
Return a list of all connections this node has open, optionally filtering
by a PeerId
-
Parameters
OptionalpeerId: PeerId
Returns Connection[]
Example
for (constconnectionoflibp2p.getConnections()) { console.log(peerId, connection.remoteAddr.toString()) // Logs the PeerId string and the observed remote multiaddr of each Connection }
+
Parameters
OptionalpeerId: PeerId
Returns Connection[]
Example
for (constconnectionoflibp2p.getConnections()) { console.log(peerId, connection.remoteAddr.toString()) // Logs the PeerId string and the observed remote multiaddr of each Connection }
Return a list of all connections this node has open, optionally filtering
by a PeerId
-
Parameters
OptionalpeerId: PeerId
Returns Connection[]
Example
for (constconnectionoflibp2p.getConnections()) { console.log(peerId, connection.remoteAddr.toString()) // Logs the PeerId string and the observed remote multiaddr of each Connection }
+
Parameters
OptionalpeerId: PeerId
Returns Connection[]
Example
for (constconnectionoflibp2p.getConnections()) { console.log(peerId, connection.remoteAddr.toString()) // Logs the PeerId string and the observed remote multiaddr of each Connection }
\ No newline at end of file
diff --git a/classes/_waku_core.waku_filter.FilterCore.html b/classes/_waku_core.waku_filter.FilterCore.html
index c8b703ef37..01a71998d8 100644
--- a/classes/_waku_core.waku_filter.FilterCore.html
+++ b/classes/_waku_core.waku_filter.FilterCore.html
@@ -1,4 +1,4 @@
-FilterCore | Documentation
\ No newline at end of file
diff --git a/classes/_waku_core.waku_light_push.LightPushCore.html b/classes/_waku_core.waku_light_push.LightPushCore.html
index 72bb6cad4c..5ceaa5c2e9 100644
--- a/classes/_waku_core.waku_light_push.LightPushCore.html
+++ b/classes/_waku_core.waku_light_push.LightPushCore.html
@@ -1,5 +1,5 @@
LightPushCore | Documentation
Attempts to establish a connection with a peer and set up specified protocols. +