Skip to content

bpo-33921: Clarify how to bind to all interfaces using socket #7877

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 28, 2018
Merged

bpo-33921: Clarify how to bind to all interfaces using socket #7877

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04ec784
Clarify how to bind to all interfaces using socket
johnthagen Jun 23, 2018
3a3cff7
Remove trailing whitespace
johnthagen Jun 23, 2018
77ac3b2
Remove whitespace
johnthagen Jun 23, 2018
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
13 changes: 7 additions & 6 deletions Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ created. Socket addresses are represented as follows:
notation like ``'daring.cwi.nl'`` or an IPv4 address like ``'100.50.200.5'``,
and *port* is an integer.

- For IPv4 addresses, two special forms are accepted instead of a host
address: ``''`` represents :const:`INADDR_ANY`, which is used to bind to all
interfaces, and the string ``'<broadcast>'`` represents
:const:`INADDR_BROADCAST`. This behavior is not compatible with IPv6,
therefore, you may want to avoid these if you intend to support IPv6 with your
Python programs.

- For :const:`AF_INET6` address family, a four-tuple ``(host, port, flowinfo,
scopeid)`` is used, where *flowinfo* and *scopeid* represent the ``sin6_flowinfo``
and ``sin6_scope_id`` members in :const:`struct sockaddr_in6` in C. For
Expand Down Expand Up @@ -171,12 +178,6 @@ created. Socket addresses are represented as follows:

.. XXX document them!

For IPv4 addresses, two special forms are accepted instead of a host address:
the empty string represents :const:`INADDR_ANY`, and the string
``'<broadcast>'`` represents :const:`INADDR_BROADCAST`. This behavior is not
compatible with IPv6, therefore, you may want to avoid these if you intend
to support IPv6 with your Python programs.

If you use a hostname in the *host* portion of IPv4/v6 socket address, the
program may show a nondeterministic behavior, as Python uses the first address
returned from the DNS resolution. The socket address will be resolved
Expand Down