mirror of
https://github.com/python/cpython
synced 2024-09-15 23:46:26 +00:00
Correct documentation for AF_PACKET (#112339)
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:
parent
b90a5cf11c
commit
562d7149c6
|
@ -185,7 +185,7 @@ created. Socket addresses are represented as follows:
|
||||||
.. versionadded:: 3.7
|
.. versionadded:: 3.7
|
||||||
|
|
||||||
- :const:`AF_PACKET` is a low-level interface directly to network devices.
|
- :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, proto[, pkttype[, hatype[, addr]]])`` where:
|
||||||
|
|
||||||
- *ifname* - String specifying the device name.
|
- *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,
|
May be :data:`ETH_P_ALL` to capture all protocols,
|
||||||
one of the :ref:`ETHERTYPE_* constants <socket-ethernet-types>`
|
one of the :ref:`ETHERTYPE_* constants <socket-ethernet-types>`
|
||||||
or any other Ethernet protocol number.
|
or any other Ethernet protocol number.
|
||||||
Value must be in network-byte-order.
|
|
||||||
- *pkttype* - Optional integer specifying the packet type:
|
- *pkttype* - Optional integer specifying the packet type:
|
||||||
|
|
||||||
- ``PACKET_HOST`` (the default) - Packet addressed to the local host.
|
- ``PACKET_HOST`` (the default) - Packet addressed to the local host.
|
||||||
|
|
Loading…
Reference in a new issue