-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Open
bmk
wants to merge
1
commit into
erlang:master
Choose a base branch
from
bmk:bmk/erts/20250227/document_socket_configure_flags
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -524,3 +524,69 @@ Options for level `sctp`: | |
| rtoinfo | sctp_rtoinfo() | yes | yes | none | | ||
|
||
_Table: sctp options_ | ||
|
||
|
||
[](){: #socket_configure_flags } | ||
|
||
## Socket Configure Flags | ||
|
||
There are a couple of configure flags, that can be used when (configure and) | ||
building Erlang/OTP, which effect the functionality of the 'socket' nif. | ||
|
||
### Builtin Socket Support | ||
|
||
Support for the builtin 'socket' (as a nif) can be explicitly enabled and | ||
disabled: | ||
|
||
```text | ||
--enable-esock (default) | --disable-esock | ||
``` | ||
|
||
### RCVTIMEO/SNDTIMEO socket options | ||
|
||
Support for these (socket) options has to be explicitly enabled (see why above): | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I do not understand what part of above motivates this!? |
||
```text | ||
--enable-esock-rcvsndtimeo | --disable-esock-rcvsndtimeo (default) | ||
``` | ||
|
||
### Extended Error Info | ||
|
||
The use of Extended Error Info (currently only used on Windows) can be | ||
explicitly enabled and disabled: | ||
|
||
```text | ||
--enable-esock-extended-error-info (default) | --disable-esock-extended-error-info | ||
``` | ||
|
||
### Verbose Mutex Names | ||
|
||
The use of verbose mutex names (in the 'socket' nif) can be explicitly | ||
enabled and disabled: | ||
|
||
```text | ||
--enable-esock-verbose-mtx-names (default) | --disable-esock-verbose-mtx-names | ||
``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is unclear to me why anyone should care about this, is it a memory/debug tradeoff? |
||
|
||
### Counter Size | ||
|
||
The 'socket' nif uses counters for various things (e.g. number of send | ||
attempts). The size (in number of bits) of these counters can be explictly | ||
configured: | ||
|
||
```text | ||
--with-esock-counter-size=SZ | ||
``` | ||
|
||
Where SZ is one of 16 | 24 | 32 | 48 | 64. Defaults to 64. | ||
|
||
### Socket Registry | ||
|
||
The socket registry keeps track of 'socket' sockets. | ||
This can be explicitly enabled and disabled: | ||
|
||
```text | ||
--enable-esock-socket-registry (default) | --disable-esock-socket-registry | ||
``` | ||
|
||
See above for more info. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no need to have this, you can link directly to the header:
socket_usage.md#socket-configure-flags
.