Skip to content

docs: correct queue capacity and dial overflow semantics - #3674

Merged
tabcat merged 1 commit into
libp2p:mainfrom
fmtappendf:main
Oct 19, 2026
Merged

tabcat merged 1 commit into
libp2p:mainfrom
fmtappendf:main

Conversation

@fmtappendf

@fmtappendf fmtappendf commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Title

docs: correct queue capacity and dial overflow semantics

Description

The queue documentation currently misstates two behaviors:

  • maxDialQueueLength claims dial requests wait for capacity. New dial
    jobs actually reject with DialError when the queue is full; requests
    that join existing dial jobs are still allowed.
  • onSizeLessThan claims running jobs are excluded. Its size check
    includes both waiting and running jobs.

Update both comments and supply the required limit argument in the
onSizeLessThan example. No runtime behavior changes.

Notes & open questions

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

Signed-off-by: fmtappendf <fmtappendf@gmail.com>
@fmtappendf
fmtappendf requested a review from a team as a code owner October 19, 2026 02:51
@tabcat
tabcat merged commit c57bf62 into libp2p:main Oct 19, 2026
36 checks passed
@tabcat tabcat mentioned this pull request Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants