docs/library/socket.rst: Document socket as a class.
Following CPython: https://bugs.python.org/issue45772
This commit is contained in:
parent
cd0531c533
commit
2c30ac7aeb
@ -66,19 +66,6 @@ Tuple address format for ``socket`` module:
|
|||||||
Functions
|
Functions
|
||||||
---------
|
---------
|
||||||
|
|
||||||
.. function:: socket(af=AF_INET, type=SOCK_STREAM, proto=IPPROTO_TCP, /)
|
|
||||||
|
|
||||||
Create a new socket using the given address family, socket type and
|
|
||||||
protocol number. Note that specifying *proto* in most cases is not
|
|
||||||
required (and not recommended, as some MicroPython ports may omit
|
|
||||||
``IPPROTO_*`` constants). Instead, *type* argument will select needed
|
|
||||||
protocol automatically::
|
|
||||||
|
|
||||||
# Create STREAM TCP socket
|
|
||||||
socket(AF_INET, SOCK_STREAM)
|
|
||||||
# Create DGRAM UDP socket
|
|
||||||
socket(AF_INET, SOCK_DGRAM)
|
|
||||||
|
|
||||||
.. function:: getaddrinfo(host, port, af=0, type=0, proto=0, flags=0, /)
|
.. function:: getaddrinfo(host, port, af=0, type=0, proto=0, flags=0, /)
|
||||||
|
|
||||||
Translate the host/port argument into a sequence of 5-tuples that contain all the
|
Translate the host/port argument into a sequence of 5-tuples that contain all the
|
||||||
@ -176,6 +163,19 @@ Constants specific to WiPy:
|
|||||||
class socket
|
class socket
|
||||||
============
|
============
|
||||||
|
|
||||||
|
.. class:: socket(af=AF_INET, type=SOCK_STREAM, proto=IPPROTO_TCP, /)
|
||||||
|
|
||||||
|
Create a new socket using the given address family, socket type and
|
||||||
|
protocol number. Note that specifying *proto* in most cases is not
|
||||||
|
required (and not recommended, as some MicroPython ports may omit
|
||||||
|
``IPPROTO_*`` constants). Instead, *type* argument will select needed
|
||||||
|
protocol automatically::
|
||||||
|
|
||||||
|
# Create STREAM TCP socket
|
||||||
|
socket(AF_INET, SOCK_STREAM)
|
||||||
|
# Create DGRAM UDP socket
|
||||||
|
socket(AF_INET, SOCK_DGRAM)
|
||||||
|
|
||||||
Methods
|
Methods
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user