languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-07-19 19:54:39 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Correct documentation for AF_PACKET (#112339)

Browse source 
Protocol in the address tuple should *not* be in the network-byte-order, because it is converted internally[1].

[1] 89ddea4886/Modules/socketmodule.c (L2144)

network byte order doesn't make sense for a python level int anyways. It's a fixed size C serialization concept.
This commit is contained in:
Eugene Toder 2023-11-27 18:42:37 -05:00 committed by GitHub
parent b90a5cf11c
commit 562d7149c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Doc/library/socket.rst
View file

@ -185,7 +185,7 @@ created. Socket addresses are represented as follows:
.. versionadded:: 3.7
- :const:`AF_PACKET` is a low-level interface directly to network devices.
The packets are represented by the tuple
The addresses are represented by the tuple
``(ifname, proto[, pkttype[, hatype[, addr]]])`` where:
- *ifname* - String specifying the device name.
@ -193,7 +193,6 @@ created. Socket addresses are represented as follows:
May be :data:`ETH_P_ALL` to capture all protocols,
one of the :ref:`ETHERTYPE_* constants <socket-ethernet-types>`
or any other Ethernet protocol number.
Value must be in network-byte-order.
- *pkttype* - Optional integer specifying the packet type:
- ``PACKET_HOST`` (the default) - Packet addressed to the local host.