doc: clarify protocol-tag family/type/protocol return values#273
doc: clarify protocol-tag family/type/protocol return values#273mvandeberg wants to merge 1 commit into
Conversation
The family()/type()/protocol() members on the protocol tags returned bare platform constants documented as "the protocol (0)", which read as one entry in an unlisted corosio enumeration (cppalliance#255). Explain at the class level that these three members produce the (family, type, protocol) triple passed to the OS socket() call and that the values are platform-defined constants, and expand local_stream/local_datagram protocol() to state that 0 selects the default (and only) protocol rather than indexing a list. Clarify the socket/acceptor type aliases across all four tags. Documentation only; no API or behavior change.
|
An automated preview of the documentation is available at https://273.corosio.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-06-11 16:17:11 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #273 +/- ##
========================================
Coverage 77.73% 77.73%
========================================
Files 96 96
Lines 7234 7234
Branches 1764 1764
========================================
Hits 5623 5623
Misses 1102 1102
Partials 509 509
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
|
GCOVR code coverage report https://273.corosio.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-06-11 16:37:49 UTC |
2 participants
The family()/type()/protocol() members on the protocol tags returned bare platform constants documented as "the protocol (0)", which read as one entry in an unlisted corosio enumeration (#255).
Explain at the class level that these three members produce the (family, type, protocol) triple passed to the OS socket() call and that the values are platform-defined constants, and expand local_stream/local_datagram protocol() to state that 0 selects the default (and only) protocol rather than indexing a list. Clarify the socket/acceptor type aliases across all four tags.
Documentation only; no API or behavior change.