usocket – socket 模块

这个模块实现了相应 CPython 模块的一个子集，如下所述。有关更多信息，请参阅原始CPython文档: socket

该模块提供BSD socket接口的访问。

与CPython区别

为提高效率与一致性，MicroPython中的套接字对象直接实现 stream`（类文件）接口。在CPython中， 需使用 ``makefile()` 方法来将socket转换为类文件对象。该方法仍由MicroPython（但是是无操作）支持， 所以在CPython的兼容性问题上，请一定使用该方法。

Socket地址格式

下面函数使用 (ipv4_address, port) 网络地址, ipv4_address 是由点和数字组成的字符串，如 "8.8.8.8" ， 端口是 1-65535 的数字。注意不能使用域名做为 ipv4_address，域名需要先用 socket.getaddrinfo() 进行解析。

usocket 模块的本机套接字地址格式是一个由 getaddrinfo 函数返回的不透明数据类型， 须用其来解析文本地址（包括数字型地址）:

sockaddr = usocket.getaddrinfo('www.micropython.org', 80)[0][-1]
# You must use getaddrinfo() even for numeric addresses 您必须使用getaddrinfo()，即使是用于数字型地址
sockaddr = usocket.getaddrinfo('127.0.0.1', 80)[0][-1]
# Now you can use that address 现在您可以使用这一地址了
sock.connect(addr)

使用 getaddrinfo 是处理地址最有效（在内存和处理能力方面皆是如此）且最便捷的方式。

函数

usocket.socket(af=AF_INET, type=SOCK_STREAM, proto=IPPROTO_TCP)

  • af ：地址

    • socket.AF_INET:=2 — TCP/IP – IPv4

    • socket.AF_INET6 :=10 — TCP/IP – IPv6

  • type ：socket类型

    • socket.SOCK_STREAM:=1 — TCP流

    • socket.SOCK_DGRAM:=2 — UDP数据报

    • socket.SOCK_RAW :=3 — 原始套接字

    • socket.SO_REUSEADDR : =4 — socket可重用

  • proto ：协议号

    • socket.IPPROTO_TCP =6

    • socket.IPPROTO_UDP =17

一般不指定proto参数，因为有些MicroPython固件提供默认参数:

>>> s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
>>> print(s)
<socket>
usocket.getaddrinfo(host, port)

将主机域名（host）和端口（port）转换为用于创建套接字的5元组序列。元组列表的结构如下:

(family, type, proto, canonname, sockaddr)

下面显示了怎样连接到一个网址:

s = usocket.socket()
s.connect(usocket.getaddrinfo('www.micropython.org', 80)[0][-1])

与CPython区别

该函数发生错误时，会引发一个 socket.gaierror 异常（ OSError 子类）。 MicroPython并不具有 socket.gaierror ，会直接引发OSError。 注意： getaddrinfo() 的错误数量组成一个单独的名称空间， 可能与 uerrno 系统错误代码模块中的错误数量不匹配。 为区分 getaddrinfo() 错误，该错误使用负数标记，标准系统错误为正数（错误数可通过使用异常对象的 e.args[0] 特性访问）。 暂时使用负数，未来可能改变。

socket类

方法

socket.close()

标记套接字已关闭并释放所有资源。一旦发生这种情况，套接字对象上的所有未来操作都将失败。如果协议支持，远程端将接收EOF指示。

内存碎片回收时socket会自动关闭，但还是推荐在必要时用 close() 去关闭

socket.bind(address)

以列表或元组的方式绑定地址和端口号。套接字必须尚未绑定。

  • address ：一个包含地址和端口号的列表或元组。

示例:

addr = ("127.0.0.1",10000)
s.bind(addr)
socket.listen([backlog])

监听socket，使服务器能够接收连接。如果指定了 backlog ，则必须至少为0（如果低，则将其设置为0）; 并指定在拒绝新连接之前系统将允许的未接受连接数。如果未指定，则选择默认的合理值。

  • backlog ：接受套接字的最大个数，至少为0，如果没有指定，则默认一个合理值。

socket.accept()

接收连接请求。socket需要指定地址并监听连接。返回值是 (conn, address)， 其中conn是用来接收和发送数据的套接字，address是绑定到另一端的套接字。

  • conn：新的套接字对象，可以用来收发消息

  • address：连接到服务器的客户端地址

socket.connect(address)

连接到指定地址的远端套接字。

  • address：地址和端口号的元组或列表

示例:

host = "192.168.3.147"
port = 100
s.connect((host, port))
socket.send(bytes)

将数据发送到套接字。套接字必须连接到远程套接字。返回发送的字节数，可能小于数据长度 (“short write”)。

  • bytes：bytes类型数据

socket.sendall(bytes)

将所有数据发送到套接字。套接字必须连接到远程套接字。与 send() 此不同，此方法将尝试通过连续发送数据块来发送所有数据。

此方法在非阻塞套接字上的行为未定义。因此，在MicroPython上，建议使用 write() 方法，它具有相同的“无短写入”策略来阻塞套接字，并将返回在非阻塞套接字上发送的字节数。

  • bytes：bytes类型数据

socket.recv(bufsize)

从套接字接收数据。返回值是表示接收数据的字节对象。一次接收的最大数据量由 bufsize 指定。

  • bufsize：指定一次接收的最大数据量

示例:

data = conn.recv(1024)
socket.sendto(bytes, address)

将数据发送到套接字。套接字不应连接到远程套接字，因为目标套接字由地址指定。用于UDP通信，返回发送的数据大小。

  • bytes：bytes类型数据

  • address：目标地址和端口号的元组

socket.recvfrom(bufsize)

从套接字接收数据。返回值是一对（字节，地址），其中bytes是表示接收数据的字节对象，address是发送数据的套接字的地址。用于UDP通信。

  • bufsize：指定一次接收的最大数据量

socket.setsockopt(level, optname, value)

设置给定套接字选项的值。所需的符号常量在套接字模块中定义（SO_ *等）。该值可以是整数或表示缓冲区的类字节对象。

  • level：套接字选项级别

  • optname：socket 选项

  • value：可以是一个整数，也可以是一个表示缓冲区的bytes类对象。

示例:

s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
socket.settimeout(value)

设置超时时间，单位：秒。

设置超时。value 参数可以是表示秒的非负浮点数，也可以是 None 。如果给出非零值，则OSError如果在操作完成之前已超过超时时间段值，则后续套接字操作将引发异常。 如果给出零，则套接字处于非阻塞模式。如果给出 None ，则套接字处于阻塞模式。

示例:

s.settimeout(2)
socket.setblocking(flag)

设置socket的阻塞或非阻塞模式：若标记为false，则将该socket设置为非阻塞模式，而非阻塞模式。

该方法为某些settimeout()调用的简写:

  • sock.setblocking(True) 相当于 sock.settimeout(None)

  • sock.setblocking(False) 相当于 sock.settimeout(0)

Difference to CPython

CPython socket.timeout在超时的情况下引发异常，这是一个OSError子类。MicroPython直接引发OSError。 如果您用来捕获异常，那么您的代码将在MicroPython和CPython中都有效。

socket.makefile(mode='rb', buffering=0)

返回一个与socket相关联的文件对象。具体的返回类型取决于给定makefile()的参数。该支持仅限于二进制模式（ ‘rb’ 和 ‘wb’ ）。 CPython的参数为：不支持 encoding 、 errors 、 newline 。

Socket须为阻塞模式；允许超时存在，但若出现超时，文件对象的内部缓冲区可能会以不一致状态结束。

与CPython区别

  • 由于MicroPython不支持缓冲流，则将忽略缓冲参数的值，且将按照该值为0（未缓冲）时处理。

  • 关闭所有由makefile()返回的文件对象，同样将关闭原始socket。

socket.read([size])

从socket中读取size字节。返回一个字节对象。若未给定 size ，则按照类似 socket.readall() 的模式运行，见下。

socket.readinto(buf[, nbytes])

将字节读取入缓冲区。若指定 nbytes ，则最多读取该数量的字节。否则，最多读取 len(buf) 数量的字节。 正如 read() ，该方法遵循“no short reads”方法。

返回值：读取并存入缓冲区的字节数量

socket.readline()

接收一行数据，遇换行符结束，并返回接收数据的对象 。

socket.write(buf)

将字节缓冲区写入套接字。此函数将尝试将所有数据写入套接字（无“短写”）。 但是，对于非阻塞套接字，这可能是不可能的，并且返回值将小于buf的长度。

返回值：写入的字节数。

exception usocket.error

MicroPython没有此异常。

Difference to CPython

CPython曾经有一个socket.error现已弃用的异常，并且是别名 OSError 。在MicroPython中，OSError 直接使用。

常数

usocket.AF_INET
usocket.AF_INET6

地址簇

usocket.SOCK_STREAM
usocket.SOCK_DGRAM

套接字类型

usocket.IPPROTO_UDP
usocket.IPPROTO_TCP

IP协议号

usocket.SOL_SOCKET

socket选项级别,默认=4095