Commit 9915da4
docs(vsock): add detailed documentation for credit flow control
Add comprehensive documentation for credit-based flow control functions:
1. harvest_stream_reads():
- Explains credit checking before reading
- Documents tx_cnt tracking
- Describes burst reading behavior
2. available_tx_credit():
- Detailed formula explanation
- Describes each variable's meaning
- Explains the in-flight bytes concept
This improves code maintainability by making the credit flow control
algorithm easier to understand for future developers.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>1 parent b985444 commit 9915da4
1 file changed
Lines changed: 20 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
443 | 443 | | |
444 | 444 | | |
445 | 445 | | |
446 | | - | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
447 | 457 | | |
448 | 458 | | |
449 | 459 | | |
| |||
511 | 521 | | |
512 | 522 | | |
513 | 523 | | |
| 524 | + | |
| 525 | + | |
| 526 | + | |
| 527 | + | |
| 528 | + | |
| 529 | + | |
| 530 | + | |
| 531 | + | |
| 532 | + | |
514 | 533 | | |
515 | 534 | | |
516 | 535 | | |
| |||
0 commit comments