kernel: gen_sctp: document the {sctp_error, ...} message #10400
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
CT Test Results 2 files 72 suites 1h 7m 1s ⏱️ For more details on these failures, see this check. Results for commit 28743c0. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts
// Erlang/OTP Github Action Bot |
wojtekmach
reviewed
Nov 25, 2025
lib/kernel/src/gen_sctp.erl
Outdated
| {sctp, Socket, FromIP, FromPort, {AncData, Data}} | ||
| ``` | ||
|
|
||
| Error-related events - such as `#sctp_send_failed{}`, `#sctp_pdapi_event`, |
Contributor
There was a problem hiding this comment.
Suggested change
| Error-related events - such as `#sctp_send_failed{}`, `#sctp_pdapi_event`, | |
| Error-related events - such as `#sctp_send_failed{}`, `#sctp_pdapi_event{}`, |
Contributor
Author
There was a problem hiding this comment.
Thank you! Applied.
The `{sctp_error, ...}` message is not documented, but it does exist.
The logic that generates both `{sctp, ...}` and `{sctp_error, ...}`
messages resides in inet_drv.c, specifically in packet_binary_message()
and sctp_parse_async_event(). Within sctp_parse_async_event(), an error
is indicated by replacing the initial `sctp` atom with `sctp_error`.
The following SCTP events are currently reported as errors:
* SCTP_SEND_FAILED (becomes #sctp_send_failed{}),
* SCTP_REMOTE_ERROR (becomes #sctp_remote_error{}),
* SCTP_PARTIAL_DELIVERY_EVENT (becomes #sctp_pdapi_event{}).
Document this and update the example code to print errors.
bmk
approved these changes
Nov 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
{sctp_error, ...}message is not documented, but it does exist. The logic that generates both{sctp, ...}and{sctp_error, ...}messages resides in inet_drv.c, specifically inpacket_binary_message()andsctp_parse_async_event(). Withinsctp_parse_async_event(), an error is indicated by replacing the initialsctpatom withsctp_error.The following SCTP events are currently reported as errors:
SCTP_SEND_FAILED(becomes#sctp_send_failed{}),SCTP_REMOTE_ERROR(becomes#sctp_remote_error{}),SCTP_PARTIAL_DELIVERY_EVENT(becomes#sctp_pdapi_event{}).Document this and update the example code to print errors.