Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a configure chapter to the socket usage guide #9508

Merged

Conversation

bmk
Copy link
Contributor

@bmk bmk commented Feb 27, 2025

Add a chapter to the socket usage guide, describing all the 'socket' configure options.

@bmk bmk requested a review from RaimoNiskanen February 27, 2025 10:18
@bmk bmk added team:PS Assigned to OTP team PS testing currently being tested, tag is used by OTP internal CI labels Feb 27, 2025
Copy link
Contributor

github-actions bot commented Feb 27, 2025

CT Test Results

    2 files     70 suites   1h 7m 46s ⏱️
1 567 tests 1 324 ✅ 242 💤 1 ❌
1 818 runs  1 524 ✅ 293 💤 1 ❌

For more details on these failures, see this check.

Results for commit d72db9c.

♻️ 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

@IngelaAndin
Copy link
Contributor

As it is a user guide maybe it would be motivated to hint what the tradeoffs are for all the options even if some of them feel more obvious ?!

@bmk bmk force-pushed the bmk/erts/20250227/document_socket_configure_flags branch from 802b325 to 43b58e0 Compare March 4, 2025 15:49
@IngelaAndin
Copy link
Contributor

IngelaAndin commented Mar 5, 2025

@bmk In the table where you reference RCVTIMEO/SNDTIMEO you have "see below " references, I think that is only confusing.
I would suggest writing something along the lines

"Is not supported by default. If support is wanted it has to be enabled at build time with the configure flags ... , however we recommend using other means of timeouts, for instance ... , as these timeouts may cause unwanted behavior when used in an asynchronous message handling environment as our socket API"

@bmk bmk merged commit 0e411f7 into erlang:master Mar 6, 2025
24 of 27 checks passed
@bmk bmk removed the testing currently being tested, tag is used by OTP internal CI label Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team:PS Assigned to OTP team PS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants