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

Documentation fix for Socket.Select #9992

Merged
merged 2 commits into from
Jul 19, 2024

Conversation

logiclrd
Copy link
Contributor

@logiclrd logiclrd commented Jun 4, 2024

The Socket.Select documentation (for the overload where timeout is a System.TimeSpan) states that ArgumentNullException is thrown if any of checkRead, checkWrite or checkError is empty/null. But, null or empty collections can be passed for them. The real requirement is that at least one of them must contain at least one socket. It is perfectly okay to select(read_sockets, NULL, NULL) or select(NULL, write_sockets, NULL) or select(NULL, NULL, error_sockets).

@logiclrd logiclrd requested a review from a team as a code owner June 4, 2024 01:34
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Jun 4, 2024
Copy link
Contributor

Tagging subscribers to this area: @dotnet/ncl

This comment was marked as outdated.

`System.TimesSpan` states that `ArgumentNullException` is thrown if any
of checkRead, checkWrite or checkError is empty/null. But, null or empty
collections can be passed for them. The real requirement is that at
least one of them must contain at least one socket. It is perfectly okay
to `select(read_sockets, NULL, NULL)` or `select(NULL, write_sockets,
NULL)` or `select(NULL, NULL, error_sockets)`.
@logiclrd logiclrd force-pushed the JDG_SocketSelectDocumentationFix branch from 3614685 to dca5418 Compare June 4, 2024 03:54
Copy link

Learn Build status updates of commit dca5418:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Net.Sockets/Socket.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Member

@antonfirsov antonfirsov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@gewarren gewarren enabled auto-merge (squash) July 19, 2024 23:04
Copy link

Learn Build status updates of commit 0ab0a2b:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Net.Sockets/Socket.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@gewarren gewarren merged commit 10d6ad9 into dotnet:main Jul 19, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Net.Sockets community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants