fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-05-11 10:17:19 +00:00
Code Issues Projects Releases Wiki Activity

refactor: PER_PEER_LIMIT is now MAX_PER_PEER_DIALS

Browse Source
This commit is contained in:
Jacob Heun 2019-12-04 13:58:23 +01:00
parent 571fd3b7d1
commit d5405dbb08
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/DIALER.md
View File

@ -2,7 +2,7 @@
**Synopsis** **Synopsis**
* All Dial Requests in js-libp2p must request a token(s) from the Dialer. * All Dial Requests in js-libp2p must request a token(s) from the Dialer.
* The number of tokens requested should be between 1 and the PER_PEER_LIMIT max set in the Dialer. * The number of tokens requested should be between 1 and the MAX_PER_PEER_DIALS max set in the Dialer.
* If the number of available tokens is less than requested, the Dialer may return less than requested. * If the number of available tokens is less than requested, the Dialer may return less than requested.
* The number of tokens a DialRequest obtains reflects the maximum number of parallel Multiaddr Dials it can make. * The number of tokens a DialRequest obtains reflects the maximum number of parallel Multiaddr Dials it can make.
* If no tokens are available a DialRequest should immediately end and throw. This deviates from the existing queue system to avoid queue congestion and provide more visibility to users. * If no tokens are available a DialRequest should immediately end and throw. This deviates from the existing queue system to avoid queue congestion and provide more visibility to users.
@ -24,11 +24,11 @@ An effective dialing system should involve the inclusion of a Confidence system
## Notes ## Notes
* A DialRequest gets a set of tokens from the Dialer, up to the PER_PEER_LIMIT max. * A DialRequest gets a set of tokens from the Dialer, up to the MAX_PER_PEER_DIALS max.
* A DialRequest SHOULD release its tokens after the DIAL_TIMEOUT has expired. This ensures that a peer with a large set of hanging addresses, does not block future dials. * A DialRequest SHOULD release its tokens after the DIAL_TIMEOUT has expired. This ensures that a peer with a large set of hanging addresses, does not block future dials.
* Upon releasing the tokens, the Dialer may allocate them to another DialRequest. * Upon releasing the tokens, the Dialer may allocate them to another DialRequest.
* A DialRequest SHOULD fail if no dial tokens are available. The DialRequest MAY proceed without tokens, but this should be reserved for High Priority actions and should be rare. * A DialRequest SHOULD fail if no dial tokens are available. The DialRequest MAY proceed without tokens, but this should be reserved for High Priority actions and should be rare.
* A DialRequest MUST NOT request more tokens than it has addresses to dial. Example: If the PER_PEER_LIMIT max is 4 and a DialRequest has 1 address, it should only request 1 token. * A DialRequest MUST NOT request more tokens than it has addresses to dial. Example: If the MAX_PER_PEER_DIALS max is 4 and a DialRequest has 1 address, it should only request 1 token.
* A DialRequest MUST execute parallel dials for each of its addresses up the total number of tokens it has. * A DialRequest MUST execute parallel dials for each of its addresses up the total number of tokens it has.
* On a successful dial, the DialRequest MUST abort any other in progress dials, return the successful connection and release all tokens. * On a successful dial, the DialRequest MUST abort any other in progress dials, return the successful connection and release all tokens.
* A new DialRequest SHOULD be given a descending list of prioritized Multiaddrs, based on their confidence. Having higher confidence Multiaddrs first can help minimize the time a DialRequest is active. * A new DialRequest SHOULD be given a descending list of prioritized Multiaddrs, based on their confidence. Having higher confidence Multiaddrs first can help minimize the time a DialRequest is active.

4
src/dialer.js
View File

@ -14,7 +14,7 @@ const { codes } = require('./errors')
const { const {
DIAL_TIMEOUT, DIAL_TIMEOUT,
MAX_PARALLEL_DIALS, MAX_PARALLEL_DIALS,
PER_PEER_LIMIT MAX_PER_PEER_DIALS
} = require('./constants') } = require('./constants')
class Dialer { class Dialer {
@ -31,7 +31,7 @@ class Dialer {
peerStore, peerStore,
concurrency = MAX_PARALLEL_DIALS, concurrency = MAX_PARALLEL_DIALS,
timeout = DIAL_TIMEOUT, timeout = DIAL_TIMEOUT,
perPeerLimit = PER_PEER_LIMIT perPeerLimit = MAX_PER_PEER_DIALS
}) { }) {
this.transportManager = transportManager this.transportManager = transportManager
this.peerStore = peerStore this.peerStore = peerStore