gdamore · 2026-06-07T23:08:12Z

fixes #2168 nng_listener_start can return more errors

Document that nng_listener_start can return NNG_EADDRINUSE when the listener address is already in use and NNG_EPERM when binding is denied.

Validated with git diff --check.

You agree that by submitting a PR, you have read and agreed to our contributing guidelines.

Summary by CodeRabbit

Documentation
- Updated nng_listener_start documentation to include additional error code information.

coderabbitai · 2026-06-07T23:08:19Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a86e6580-1a3c-48b3-aba1-6456596d8627

📥 Commits

Reviewing files that changed from the base of the PR and between b8caf85 and 7c6a5e2.

📒 Files selected for processing (1)

docs/man/nng_listener_start.3.adoc

📝 Walkthrough

Walkthrough

Updated the nng_listener_start(3) manual page to document three error codes (NNG_EADDRINUSE, NNG_ECLOSED, and NNG_EPERM) that the function can return when binding fails.

Changes

Error Documentation Update

Layer / File(s)	Summary
Document additional listener errors `docs/man/nng_listener_start.3.adoc`	The ERRORS section now lists `NNG_EADDRINUSE` (address already in use), `NNG_ECLOSED` (listener closed), and `NNG_EPERM` (permission denied when binding) with consistent formatting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A rabbit hops through error codes so fine,
Documenting paths where functions align,
EADDRINUSE, ECLOSED, and EPERM's song,
Now listeners know what errors belong! 🐇

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title '[codex] document listener start errors' clearly summarizes the main change: documentation updates for nng_listener_start error codes.
Description check	✅ Passed	The description follows the template format, includes a fixes reference (`#2168`), provides clear explanation of what was documented, and confirms validation.
Linked Issues check	✅ Passed	The pull request successfully documents the two error codes (NNG_EADDRINUSE and NNG_EPERM) that issue `#2168` identified as missing from the nng_listener_start documentation.
Out of Scope Changes check	✅ Passed	All changes are focused on documenting additional error codes for nng_listener_start as specified in issue `#2168`; no extraneous modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch gdamore/fix-doc-bug-2168

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

doc: document listener start errors (fixes #2168)

7c6a5e2

gdamore force-pushed the gdamore/fix-doc-bug-2168 branch from eafd6ab to 7c6a5e2 Compare June 7, 2026 23:09

gdamore marked this pull request as ready for review June 7, 2026 23:09

gdamore merged commit b345797 into main Jun 8, 2026
2 checks passed

Navigation Menu

Uh oh!

Uh oh!

[codex] document listener start errors - #2256