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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions lib/kernel/doc/guides/socket_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,3 +524,69 @@ Options for level `sctp`:
| rtoinfo | sctp_rtoinfo() | yes | yes | none |

_Table: sctp options_


[](){: #socket_configure_flags }
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[](){: #socket_configure_flags }

There is no need to have this, you can link directly to the header: socket_usage.md#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):

Copy link
Contributor

Choose a reason for hiding this comment

The 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
```
Copy link
Contributor

Choose a reason for hiding this comment

The 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.
Loading