socket --- 底層網(wǎng)絡(luò)接口?

套接字協(xié)議族?

根據(jù)系統(tǒng)以及構(gòu)建選項，此模塊提供了各種套接字協(xié)議簇。

特定的套接字對象需要的地址格式將根據(jù)此套接字對象被創(chuàng)建時指定的地址族被自動選擇。套接字地址表示如下：

• 一個綁定在文件系統(tǒng)節(jié)點上的 AF_UNIX 套接字的地址表示為一個字符串，使用文件系統(tǒng)字符編碼和 'surrogateescape' 錯誤回調(diào)方法（see PEP 383）。一個地址在 Linux 的抽象命名空間被返回為帶有初始的 null 字節(jié)的 字節(jié)類對象 ；注意在這個命名空間種的套接字可能與普通文件系統(tǒng)套接字通信，所以打算運行在 Linux 上的程序可能需要解決兩種地址類型。當(dāng)傳遞為參數(shù)時，一個字符串或字節(jié)類對象可以用于任一類型的地址。

  在 3.3 版更改: 之前，AF_UNIX 套接字路徑被假設(shè)使用 UTF-8 編碼。

  在 3.5 版更改: 現(xiàn)在接受可寫的 字節(jié)類對象。

• 一對 (host, port) 被用作 AF_INET 地址族，其中 host 是一個表示互聯(lián)網(wǎng)域名標(biāo)記形式的主機(jī)名例如 'daring.cwi.nl' 或者 IPv4 地址例如 '100.50.200.5' 的字符串，而 port 是一個整數(shù)值。

  • 對于 IPv4 地址，有兩種可接受的特殊形式被用來代替一個主機(jī)地址： '' 代表 INADDR_ANY，用來綁定到所有接口；字符串 '<broadcast>' 代表 INADDR_BROADCAST。此行為不兼容 IPv6，因此，如果你的 Python 程序打算支持 IPv6，則可能需要避開這些。

• 對于 AF_INET6 地址族，使用一個四元組 (host, port, flowinfo, scope_id)，其中 flowinfo 和 scope_id 代表了 C 庫 struct sockaddr_in6 中的 sin6_flowinfo 和 sin6_scope_id 成員。對于 socket 模塊中的方法， flowinfo 和 scope_id 可以被省略，只為了向后兼容。注意，省略 scope_id 可能會導(dǎo)致操作帶有領(lǐng)域 (Scope) 的 IPv6 地址時出錯。

  在 3.7 版更改: 對于多播地址（其 scope_id 起作用），地址 中可以不包含 %scope_id （或 zone id ）部分，這部分是多余的，可以放心省略（推薦）。

• AF_NETLINK 套接字由一對 (pid, groups) 表示。

• 指定 AF_TIPC 地址族可以使用僅 Linux 支持的 TIPC 協(xié)議。TIPC 是一種開放的、非基于 IP 的網(wǎng)絡(luò)協(xié)議，旨在用于集群計算環(huán)境。其地址用元組表示，其中的字段取決于地址類型。一般元組形式為 (addr_type, v1, v2, v3 [, scope])，其中：

  • addr_type 取 TIPC_ADDR_NAMESEQ、TIPC_ADDR_NAME 或 TIPC_ADDR_ID 中的一個。

  • scope 取 TIPC_ZONE_SCOPE、TIPC_CLUSTER_SCOPE 和 TIPC_NODE_SCOPE 中的一個。

  • 如果 addr_type 為 TIPC_ADDR_NAME，那么 v1 是服務(wù)器類型，v2 是端口標(biāo)識符，v3 應(yīng)為 0。

    如果 addr_type 為 TIPC_ADDR_NAMESEQ，那么 v1 是服務(wù)器類型，v2 是端口號下限，而 v3 是端口號上限。

    如果 addr_type 為 TIPC_ADDR_ID，那么 v1 是節(jié)點 (node)，v2 是 ref，v3 應(yīng)為 0。

• AF_CAN 地址族使用元組 (interface, )，其中 interface 是表示網(wǎng)絡(luò)接口名稱的字符串，如 'can0'。網(wǎng)絡(luò)接口名 '' 可以用于接收本族所有網(wǎng)絡(luò)接口的數(shù)據(jù)包。

  • CAN_ISOTP 協(xié)議接受一個元組 (interface, rx_addr, tx_addr)，其中兩個額外參數(shù)都是無符號長整數(shù)，都表示 CAN 標(biāo)識符（標(biāo)準(zhǔn)或擴(kuò)展標(biāo)識符）。

  • CAN_J1939 協(xié)議接受一個元組 (interface, name, pgn, addr)，其中額外參數(shù)有：表示 ECU 名稱的 64 位無符號整數(shù)，表示參數(shù)組號 (Parameter Group Number, PGN) 的 32 位無符號整數(shù)，以及表示地址的 8 位整數(shù)。

• PF_SYSTEM 協(xié)議簇的 SYSPROTO_CONTROL 協(xié)議接受一個字符串或元組 (id, unit)。其中字符串是內(nèi)核控件的名稱，該控件使用動態(tài)分配的 ID。而如果 ID 和內(nèi)核控件的單元 (unit) 編號都已知，或使用了已注冊的 ID，可以采用元組。

  3.3 新版功能.

• AF_BLUETOOTH 支持以下協(xié)議和地址格式：

  • BTPROTO_L2CAP 接受 (bdaddr, psm)，其中 bdaddr 為字符串格式的藍(lán)牙地址，psm 是一個整數(shù)。

  • BTPROTO_RFCOMM 接受 (bdaddr, channel)，其中 bdaddr 為字符串格式的藍(lán)牙地址，channel 是一個整數(shù)。

  • BTPROTO_HCI 接受 (device_id,)，其中 device_id 為整數(shù)或字符串，它表示接口對應(yīng)的藍(lán)牙地址（具體取決于你的系統(tǒng)，NetBSD 和 DragonFlyBSD 需要藍(lán)牙地址字符串，其他系統(tǒng)需要整數(shù)）。

    在 3.2 版更改: 添加了對 NetBSD 和 DragonFlyBSD 的支持。

  • BTPROTO_SCO 接受 bdaddr，其中 bdaddr 是 bytes 對象，其中含有字符串格式的藍(lán)牙地址（如 b'12:23:34:45:56:67' ），F(xiàn)reeBSD 不支持此協(xié)議。

• AF_ALG 是一個僅 Linux 可用的、基于套接字的接口，用于連接內(nèi)核加密算法。算法套接字可用包括 2 至 4 個元素的元組來配置 (type, name [, feat [, mask]])，其中：

  • type 是表示算法類型的字符串，如 aead、hash、skcipher 或 rng。

  • name 是表示算法類型和操作模式的字符串，如 sha256、hmac(sha256)、cbc(aes) 或 drbg_nopr_ctr_aes256。

  • feat 和 mask 是無符號 32 位整數(shù)。

  Availability: Linux 2.6.38, some algorithm types require more recent Kernels.

  3.6 新版功能.

• AF_VSOCK 用于支持虛擬機(jī)與宿主機(jī)之間的通訊。該套接字用 (CID, port) 元組表示，其中 Context ID (CID) 和 port 都是整數(shù)。

  Availability: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX Workstation >= 6.5.

  3.7 新版功能.

• AF_PACKET 是一個底層接口，直接連接至網(wǎng)卡。數(shù)據(jù)包使用元組 (ifname, proto[, pkttype[, hatype[, addr]]]) 表示，其中：

  • ifname - 指定設(shè)備名稱的字符串。

  • proto - 一個用網(wǎng)絡(luò)字節(jié)序表示的整數(shù)，指定以太網(wǎng)協(xié)議版本號。

  • pkttype - 指定數(shù)據(jù)包類型的整數(shù)（可選）：

    • PACKET_HOST （默認(rèn)） - 尋址到本地主機(jī)的數(shù)據(jù)包。

    • PACKET_BROADCAST - 物理層廣播的數(shù)據(jù)包。

    • PACKET_MULTICAST - Packet sent to a physical-layer multicast address.

    • PACKET_OTHERHOST - 被（處于混雜模式的）網(wǎng)卡驅(qū)動捕獲的、發(fā)送到其他主機(jī)的數(shù)據(jù)包。

    • PACKET_OUTGOING - 來自本地主機(jī)的、回環(huán)到一個套接字的數(shù)據(jù)包。

  • hatype - 可選整數(shù)，指定 ARP 硬件地址類型。

  • addr - 可選的類字節(jié)串對象，用于指定硬件物理地址，其解釋取決于各設(shè)備。

  Availability: Linux >= 2.2.

• AF_QIPCRTR 是一個僅 Linux 可用的、基于套接字的接口，用于與高通平臺中協(xié)處理器上運行的服務(wù)進(jìn)行通信。該地址簇用一個 (node, port) 元組表示，其中 node 和 port 為非負(fù)整數(shù)。

  Availability: Linux >= 4.7.

  3.8 新版功能.

• IPPROTO_UDPLITE 是一種 UDP 的變體，允許指定數(shù)據(jù)包的哪一部分計算入校驗碼內(nèi)。它添加了兩個可以修改的套接字選項。self.setsockopt(IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, length) 修改傳出數(shù)據(jù)包的哪一部分計算入校驗碼內(nèi)，而 self.setsockopt(IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, length) 將過濾掉計算入校驗碼的數(shù)據(jù)太少的數(shù)據(jù)包。在這兩種情況下，length 都應(yīng)在 range(8, 2**16, 8) 范圍內(nèi)。

  對于 IPv4，應(yīng)使用 socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE) 來構(gòu)造這樣的套接字；對于 IPv6，應(yīng)使用 socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE) 來構(gòu)造這樣的套接字。

  Availability: Linux >= 2.6.20, FreeBSD >= 10.1-RELEASE

  3.9 新版功能.

• AF_HYPERV is a Windows-only socket based interface for communicating with Hyper-V hosts and guests. The address family is represented as a (vm_id, service_id) tuple where the vm_id and service_id are UUID strings.

  The vm_id is the virtual machine identifier or a set of known VMID values if the target is not a specific virtual machine. Known VMID constants defined on socket are:

  • HV_GUID_ZERO

  • HV_GUID_BROADCAST

  • HV_GUID_WILDCARD - Used to bind on itself and accept connections from all partitions.

  • HV_GUID_CHILDREN - Used to bind on itself and accept connection from child partitions.

  • HV_GUID_LOOPBACK - Used as a target to itself.

  • HV_GUID_PARENT - When used as a bind accepts connection from the parent partition. When used as an address target it will connect to the parent parition.

  The service_id is the service identifier of the registered service.

  3.12 新版功能.

如果你在 IPv4/v6 套接字地址的 host 部分中使用了一個主機(jī)名，此程序可能會表現(xiàn)不確定行為，因為 Python 使用 DNS 解析返回的第一個地址。套接字地址在實際的 IPv4/v6 中以不同方式解析，根據(jù) DNS 解析和/或 host 配置。為了確定行為，在 host 部分中使用數(shù)字的地址。

All errors raise exceptions. The normal exceptions for invalid argument types and out-of-memory conditions can be raised. Errors related to socket or address semantics raise OSError or one of its subclasses.

可以用 setblocking() 設(shè)置非阻塞模式。一個基于超時的 generalization 通過 settimeout() 支持。

模塊內(nèi)容?

socket 模塊包含下列元素。

套接字對象?

套接字對象具有以下方法。除了 makefile()，其他都與套接字專用的 Unix 系統(tǒng)調(diào)用相對應(yīng)。

socket.accept()?

接受一個連接。此 socket 必須綁定到一個地址上并且監(jiān)聽連接。返回值是一個 (conn, address) 對，其中 conn 是一個 新 的套接字對象，用于在此連接上收發(fā)數(shù)據(jù)，address 是連接另一端的套接字所綁定的地址。

新創(chuàng)建的套接字是 不可繼承的。

在 3.4 版更改: 該套接字現(xiàn)在是不可繼承的。

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.bind(address)?

將套接字綁定到 address。套接字必須尚未綁定。（ address 的格式取決于地址簇 —— 參見上文）

引發(fā)一個 審計事件 socket.bind，附帶參數(shù) self、address。

socket.close()?

將套接字標(biāo)記為關(guān)閉。當(dāng) makefile() 創(chuàng)建的所有文件對象都關(guān)閉時，底層系統(tǒng)資源（如文件描述符）也將關(guān)閉。一旦上述情況發(fā)生，將來對套接字對象的所有操作都會失敗。對端將接收不到任何數(shù)據(jù)（清空隊列數(shù)據(jù)后）。

垃圾回收時，套接字會自動關(guān)閉，但建議顯式 close() 它們，或在它們周圍使用 with 語句。

在 3.6 版更改: 現(xiàn)在，如果底層的 close() 調(diào)用出錯，會拋出 OSError。

備注

close() 釋放與連接相關(guān)聯(lián)的資源，但不一定立即關(guān)閉連接。如果需要及時關(guān)閉連接，請在調(diào)用 close() 之前調(diào)用 shutdown()。

socket.connect(address)?

連接到 address 處的遠(yuǎn)程套接字。（ address 的格式取決于地址簇 —— 參見上文）

如果連接被信號中斷，則本方法將等待直至連接完成，或者如果信號處理句柄未引發(fā)異常并且套接字被阻塞或已超時則會在超時后引發(fā) TimeoutError。 對于非阻塞型套接字，如果連接被信號中斷則本方法將引發(fā) InterruptedError 異常（或信號處理句柄所引發(fā)的異常）。

引發(fā)一個 審計事件 socket.connect，附帶參數(shù) self、address。

在 3.5 版更改: 本方法現(xiàn)在將等待，直到連接完成，而不是在以下情況拋出 InterruptedError 異常。該情況為，連接被信號中斷，信號處理程序未拋出異常，且套接字阻塞中或已超時（具體解釋請參閱 PEP 475 ）。

socket.connect_ex(address)?

類似于 connect(address)，但是對于 C 級別的 connect() 調(diào)用返回的錯誤，本函數(shù)將返回錯誤指示器，而不是拋出異常（對于其他問題，如“找不到主機(jī)”，仍然可以拋出異常）。如果操作成功，則錯誤指示器為 0，否則為 errno 變量的值。這對支持如異步連接很有用。

引發(fā)一個 審計事件 socket.connect，附帶參數(shù) self、address。

socket.detach()?

將套接字對象置于關(guān)閉狀態(tài)，而底層的文件描述符實際并不關(guān)閉。返回該文件描述符，使其可以重新用于其他目的。

3.2 新版功能.

socket.dup()?

創(chuàng)建套接字的副本。

新創(chuàng)建的套接字是 不可繼承的。

在 3.4 版更改: 該套接字現(xiàn)在是不可繼承的。

socket.fileno()?

返回套接字的文件描述符（一個小整數(shù)），失敗返回 -1。配合 select.select() 使用很有用。

在 Windows 下，此方法返回的小整數(shù)在允許使用文件描述符的地方無法使用（如 os.fdopen() ）。Unix 無此限制。

socket.get_inheritable()?

獲取套接字文件描述符或套接字句柄的 可繼承標(biāo)志 ：如果子進(jìn)程可以繼承套接字則為 True，否則為 False。

3.4 新版功能.

socket.getpeername()?

返回套接字連接到的遠(yuǎn)程地址。舉例而言，這可以用于查找遠(yuǎn)程 IPv4/v6 套接字的端口號。（返回的地址格式取決于地址簇 —— 參見上文。）部分系統(tǒng)不支持此函數(shù)。

socket.getsockname()?

返回套接字本身的地址。舉例而言，這可以用于查找 IPv4/v6 套接字的端口號。（返回的地址格式取決于地址簇 —— 參見上文。）

socket.getsockopt(level, optname[, buflen])?

返回指定套接字選項的值（參閱 Unix 手冊頁 getsockopt(2) ）。所需的符號常量（ SO_* 等）已定義在本模塊中。如果未指定 buflen，則認(rèn)為該選項值為整數(shù)，由本函數(shù)返回該整數(shù)值。如果指定 buflen，則它定義了用于存放選項值的緩沖區(qū)的最大長度，且該緩沖區(qū)將作為字節(jié)對象返回。對緩沖區(qū)的解碼工作由調(diào)用者自行完成（針對編碼為字節(jié)串的 C 結(jié)構(gòu)，其解碼方法請參閱可選的內(nèi)置模塊 struct ）。

socket.getblocking()?

如果套接字處于阻塞模式，返回 True，非阻塞模式返回 False。

這相當(dāng)于檢測 socket.gettimeout() == 0。

3.7 新版功能.

socket.gettimeout()?

返回套接字操作相關(guān)的超時秒數(shù)（浮點數(shù)），未設(shè)置超時則返回 None。它反映最后一次調(diào)用 setblocking() 或 settimeout() 后的設(shè)置。

socket.ioctl(control, option)?

平臺

Windows

ioctl() 方法是 WSAIoctl 系統(tǒng)接口的有限接口。請參考 Win32 文檔 以獲取更多信息。

在其他平臺上，可以使用通用的 fcntl.fcntl() 和 fcntl.ioctl() 函數(shù)，它們接受套接字對象作為第一個參數(shù)。

當(dāng)前僅支持以下控制碼： SIO_RCVALL、SIO_KEEPALIVE_VALS 和 SIO_LOOPBACK_FAST_PATH。

在 3.6 版更改: 添加了 SIO_LOOPBACK_FAST_PATH。

socket.listen([backlog])?

啟動一個服務(wù)器用于接受連接。如果指定 backlog，則它最低為 0（小于 0 會被置為 0），它指定系統(tǒng)允許暫未 accept 的連接數(shù)，超過后將拒絕新連接。未指定則自動設(shè)為合理的默認(rèn)值。

在 3.5 版更改: backlog 參數(shù)現(xiàn)在是可選的。

socket.makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)?

返回與套接字關(guān)聯(lián)的 文件對象。返回的對象的具體類型取決于 makefile() 的參數(shù)。這些參數(shù)的解釋方式與內(nèi)置的 open() 函數(shù)相同，其中 mode 的值僅支持 'r' （默認(rèn)），'w' 和 'b'。

套接字必須處于阻塞模式，它可以有超時，但是如果發(fā)生超時，文件對象的內(nèi)部緩沖區(qū)可能會以不一致的狀態(tài)結(jié)尾。

關(guān)閉 makefile() 返回的文件對象不會關(guān)閉原始套接字，除非所有其他文件對象都已關(guān)閉且在套接字對象上調(diào)用了 socket.close()。

備注

在 Windows 上，由 makefile() 創(chuàng)建的文件類對象無法作為帶文件描述符的文件對象使用，如無法作為 subprocess.Popen() 的流參數(shù)。

socket.recv(bufsize[, flags])?

從套接字接收數(shù)據(jù)。返回值是一個字節(jié)對象，表示接收到的數(shù)據(jù)。bufsize 指定一次接收的最大數(shù)據(jù)量?？蛇x參數(shù) flags 的含義請參閱 Unix 手冊頁 recv(2)，它默認(rèn)為零。

備注

為了最佳匹配硬件和網(wǎng)絡(luò)的實際情況，bufsize 的值應(yīng)為 2 的相對較小的冪，如 4096。

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.recvfrom(bufsize[, flags])?

從套接字接收數(shù)據(jù)。返回值是一對 (bytes, address)，其中 bytes 是字節(jié)對象，表示接收到的數(shù)據(jù)，address 是發(fā)送端套接字的地址?？蛇x參數(shù) flags 的含義請參閱 Unix 手冊頁 recv(2)，它默認(rèn)為零。（ address 的格式取決于地址簇 —— 參見上文）

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

在 3.7 版更改: 對于多播 IPv6 地址，address 的第一項不會再包含 %scope_id 部分。 要獲得完整的 IPv6 地址請使用 getnameinfo()。

socket.recvmsg(bufsize[, ancbufsize[, flags]])?

從套接字接收普通數(shù)據(jù)（至多 bufsize 字節(jié)）和輔助數(shù)據(jù)。ancbufsize 參數(shù)設(shè)置用于接收輔助數(shù)據(jù)的內(nèi)部緩沖區(qū)的大?。ㄒ宰止?jié)為單位），默認(rèn)為 0，表示不接收輔助數(shù)據(jù)?？梢允褂?CMSG_SPACE() 或 CMSG_LEN() 計算輔助數(shù)據(jù)緩沖區(qū)的合適大小，無法放入緩沖區(qū)的項目可能會被截斷或丟棄。flags 參數(shù)默認(rèn)為 0，其含義與 recv() 中的相同。

返回值是一個四元組： (data, ancdata, msg_flags, address)。data 項是一個 bytes 對象，用于保存接收到的非輔助數(shù)據(jù)。ancdata 項是零個或多個元組 (cmsg_level, cmsg_type, cmsg_data) 組成的列表，表示接收到的輔助數(shù)據(jù)（控制消息）：cmsg_level 和 cmsg_type 是分別表示協(xié)議級別和協(xié)議類型的整數(shù)，而 cmsg_data 是保存相關(guān)數(shù)據(jù)的 bytes 對象。msg_flags 項由各種標(biāo)志按位或組成，表示接收消息的情況，詳細(xì)信息請參閱系統(tǒng)文檔。如果接收端套接字?jǐn)嚅_連接，則 address 是發(fā)送端套接字的地址（如果有），否則該值無指定。

某些系統(tǒng)上可以利用 AF_UNIX 套接字通過 sendmsg() 和 recvmsg() 在進(jìn)程之間傳遞文件描述符。使用此功能時（通常僅限于 SOCK_STREAM 套接字），recvmsg() 將在其輔助數(shù)據(jù)中返回以下格式的項 (socket.SOL_SOCKET, socket.SCM_RIGHTS, fds)，其中 fds 是一個 bytes 對象，是新文件描述符表示為原生 C int 類型的二進(jìn)制數(shù)組。如果 recvmsg() 在系統(tǒng)調(diào)用返回后拋出異常，它將首先關(guān)閉此機(jī)制接收到的所有文件描述符。

對于僅接收到一部分的輔助數(shù)據(jù)項，一些系統(tǒng)沒有指示其截斷長度。如果某個項目可能超出了緩沖區(qū)的末尾，recvmsg() 將發(fā)出 RuntimeWarning，并返回其在緩沖區(qū)內(nèi)的部分，前提是該對象被截斷于關(guān)聯(lián)數(shù)據(jù)開始后。

在支持 SCM_RIGHTS 機(jī)制的系統(tǒng)上，下方的函數(shù)將最多接收 maxfds 個文件描述符，返回消息數(shù)據(jù)和包含描述符的列表（同時忽略意外情況，如接收到無關(guān)的控制消息）。另請參閱 sendmsg()。

import socket, array

def recv_fds(sock, msglen, maxfds):
    fds = array.array("i")   # Array of ints
    msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize))
    for cmsg_level, cmsg_type, cmsg_data in ancdata:
        if cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS:
            # Append data, ignoring any truncated integers at the end.
            fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
    return msg, list(fds)

可用性： 大多數(shù) Unix 平臺，其他平臺也可能可用。

3.3 新版功能.

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.recvmsg_into(buffers[, ancbufsize[, flags]])?

從套接字接收普通數(shù)據(jù)和輔助數(shù)據(jù)，其行為與 recvmsg() 相同，但將非輔助數(shù)據(jù)分散到一系列緩沖區(qū)中，而不是返回新的字節(jié)對象。buffers 參數(shù)必須是可迭代對象，它迭代出可供寫入的緩沖區(qū)（如 bytearray 對象），這些緩沖區(qū)將被連續(xù)的非輔助數(shù)據(jù)塊填充，直到數(shù)據(jù)全部寫完或緩沖區(qū)用完為止。在允許使用的緩沖區(qū)數(shù)量上，操作系統(tǒng)可能會有限制（ sysconf() 的 SC_IOV_MAX 值）。ancbufsize 和 flags 參數(shù)的含義與 recvmsg() 中的相同。

返回值為四元組： (nbytes, ancdata, msg_flags, address)，其中 nbytes 是寫入緩沖區(qū)的非輔助數(shù)據(jù)的字節(jié)總數(shù)，而 ancdata、msg_flags 和 address 與 recvmsg() 中的相同。

示例:

>>>

>>> import socket
>>> s1, s2 = socket.socketpair()
>>> b1 = bytearray(b'----')
>>> b2 = bytearray(b'0123456789')
>>> b3 = bytearray(b'--------------')
>>> s1.send(b'Mary had a little lamb')
22
>>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3])
(22, [], 0, None)
>>> [b1, b2, b3]
[bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]

可用性： 大多數(shù) Unix 平臺，其他平臺也可能可用。

3.3 新版功能.

socket.recvfrom_into(buffer[, nbytes[, flags]])?

從套接字接收數(shù)據(jù)，將其寫入 buffer 而不是創(chuàng)建新的字節(jié)串。返回值是一對 (nbytes, address)，其中 nbytes 是收到的字節(jié)數(shù)，address 是發(fā)送端套接字的地址。可選參數(shù) flags 的含義請參閱 Unix 手冊頁 recv(2)，它默認(rèn)為零。（ address 的格式取決于地址簇 —— 參見上文）

socket.recv_into(buffer[, nbytes[, flags]])?

從套接字接收至多 nbytes 個字節(jié)，將其寫入緩沖區(qū)而不是創(chuàng)建新的字節(jié)串。如果 nbytes 未指定（或指定為 0），則接收至所給緩沖區(qū)的最大可用大小。返回接收到的字節(jié)數(shù)?？蛇x參數(shù) flags 的含義請參閱 Unix 手冊頁 recv(2)，它默認(rèn)為零。

socket.send(bytes[, flags])?

發(fā)送數(shù)據(jù)給套接字。本套接字必須已連接到遠(yuǎn)程套接字。可選參數(shù) flags 的含義與上述 recv() 中的相同。本方法返回已發(fā)送的字節(jié)數(shù)。應(yīng)用程序要負(fù)責(zé)檢查所有數(shù)據(jù)是否已發(fā)送，如果僅傳輸了部分?jǐn)?shù)據(jù)，程序需要自行嘗試傳輸其余數(shù)據(jù)。有關(guān)該主題的更多信息，請參考 套接字編程指南。

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.sendall(bytes[, flags])?

發(fā)送數(shù)據(jù)給套接字。本套接字必須已連接到遠(yuǎn)程套接字。可選參數(shù) flags 的含義與上述 recv() 中的相同。與 send() 不同，本方法持續(xù)從 bytes 發(fā)送數(shù)據(jù)，直到所有數(shù)據(jù)都已發(fā)送或發(fā)生錯誤為止。成功后會返回 None。出錯后會拋出一個異常，此時并沒有辦法確定成功發(fā)送了多少數(shù)據(jù)。

在 3.5 版更改: 每次成功發(fā)送數(shù)據(jù)后，套接字超時不再重置?，F(xiàn)在，套接字超時是發(fā)送所有數(shù)據(jù)的最大總持續(xù)時間。

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.sendto(bytes, address)?

socket.sendto(bytes, flags, address)

發(fā)送數(shù)據(jù)給套接字。本套接字不應(yīng)連接到遠(yuǎn)程套接字，而應(yīng)由 address 指定目標(biāo)套接字?？蛇x參數(shù) flags 的含義與上述 recv() 中的相同。本方法返回已發(fā)送的字節(jié)數(shù)。（ address 的格式取決于地址簇 —— 參見上文。）

引發(fā)一個 審計事件 socket.sendto，附帶參數(shù) self、address。

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.sendmsg(buffers[, ancdata[, flags[, address]]])?

將普通數(shù)據(jù)和輔助數(shù)據(jù)發(fā)送給套接字，將從一系列緩沖區(qū)中收集非輔助數(shù)據(jù)，并將其拼接為一條消息。buffers 參數(shù)指定的非輔助數(shù)據(jù)應(yīng)為可迭代的 字節(jié)類對象 （如 bytes 對象），在允許使用的緩沖區(qū)數(shù)量上，操作系統(tǒng)可能會有限制（ sysconf() 的 SC_IOV_MAX 值）。ancdata 參數(shù)指定的輔助數(shù)據(jù)（控制消息）應(yīng)為可迭代對象，迭代出零個或多個 (cmsg_level, cmsg_type, cmsg_data) 元組，其中 cmsg_level 和 cmsg_type 是分別指定協(xié)議級別和協(xié)議類型的整數(shù)，而 cmsg_data 是保存相關(guān)數(shù)據(jù)的字節(jié)類對象。請注意，某些系統(tǒng)（特別是沒有 CMSG_SPACE() 的系統(tǒng)）可能每次調(diào)用僅支持發(fā)送一條控制消息。flags 參數(shù)默認(rèn)為 0，與 send() 中的含義相同。如果 address 指定為除 None 以外的值，它將作為消息的目標(biāo)地址。返回值是已發(fā)送的非輔助數(shù)據(jù)的字節(jié)數(shù)。

在支持 SCM_RIGHTS 機(jī)制的系統(tǒng)上，下方的函數(shù)通過一個 AF_UNIX 套接字來發(fā)送文件描述符列表 fds。另請參閱 recvmsg()。

import socket, array

def send_fds(sock, msg, fds):
    return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])

可用性： 大多數(shù) Unix 平臺，其他平臺也可能可用。

引發(fā)一個 審計事件 socket.sendmsg，附帶參數(shù) self、address。

3.3 新版功能.

在 3.5 版更改: 如果系統(tǒng)調(diào)用被中斷，但信號處理程序沒有觸發(fā)異常，此方法現(xiàn)在會重試系統(tǒng)調(diào)用，而不是觸發(fā) InterruptedError 異常 (原因詳見 PEP 475)。

socket.sendmsg_afalg([msg, ]*, op[, iv[, assoclen[, flags]]])?

為 AF_ALG 套接字定制的 sendmsg() 版本。可為 AF_ALG 套接字設(shè)置模式、IV、AEAD 關(guān)聯(lián)數(shù)據(jù)的長度和標(biāo)志位。

可用性： Linux >= 2.6.38。

3.6 新版功能.

socket.sendfile(file, offset=0, count=None)?

使用高性能的 os.sendfile 發(fā)送文件，直到達(dá)到文件的 EOF 為止，返回已發(fā)送的字節(jié)總數(shù)。file 必須是一個以二進(jìn)制模式打開的常規(guī)文件對象。如果 os.sendfile 不可用（如 Windows）或 file 不是常規(guī)文件，將使用 send() 代替。offset 指示從哪里開始讀取文件。如果指定了 count，它確定了要發(fā)送的字節(jié)總數(shù)，而不會持續(xù)發(fā)送直到達(dá)到文件的 EOF。返回時或發(fā)生錯誤時，文件位置將更新，在這種情況下，file.tell() 可用于確定已發(fā)送的字節(jié)數(shù)。套接字必須為 SOCK_STREAM 類型。不支持非阻塞的套接字。

3.5 新版功能.

socket.set_inheritable(inheritable)?

設(shè)置套接字文件描述符或套接字句柄的 可繼承標(biāo)志。

3.4 新版功能.

socket.setblocking(flag)?

設(shè)置套接字為阻塞或非阻塞模式：如果 flag 為 false，則將套接字設(shè)置為非阻塞，否則設(shè)置為阻塞。

本方法是某些 settimeout() 調(diào)用的簡寫：

• sock.setblocking(True) 相當(dāng)于 sock.settimeout(None)

• sock.setblocking(False) 相當(dāng)于 sock.settimeout(0.0)

在 3.7 版更改: 本方法不再對 socket.type 屬性設(shè)置 SOCK_NONBLOCK 標(biāo)志。

socket.settimeout(value)?

為阻塞套接字的操作設(shè)置超時。value 參數(shù)可以是非負(fù)浮點數(shù)，表示秒，也可以是 None。如果賦為一個非零值，那么如果在操作完成前超過了超時時間 value，后續(xù)的套接字操作將拋出 timeout 異常。如果賦為 0，則套接字將處于非阻塞模式。如果指定為 None，則套接字將處于阻塞模式。

更多信息請查閱 關(guān)于套接字超時的說明。

在 3.7 版更改: 本方法不再修改 socket.type 屬性的 SOCK_NONBLOCK 標(biāo)志。

socket.setsockopt(level, optname, value: int)?

socket.setsockopt(level, optname, value: buffer)

socket.setsockopt(level, optname, None, optlen: int)

設(shè)置給定套接字選項的值（參閱 Unix 手冊頁 setsockopt(2) ）。所需的符號常量（ SO_* 等）已定義在本 socket 模塊中。該值可以是整數(shù)、None 或表示緩沖區(qū)的 字節(jié)類對象。在后一種情況下，由調(diào)用者確保字節(jié)串中包含正確的數(shù)據(jù)位（關(guān)于將 C 結(jié)構(gòu)體編碼為字節(jié)串的方法，請參閱可選的內(nèi)置模塊 struct ）。當(dāng) value 設(shè)置為 None 時，必須設(shè)置 optlen 參數(shù)。這相當(dāng)于調(diào)用 setsockopt() C 函數(shù)時使用了 optval=NULL 和 optlen=optlen 參數(shù)。

在 3.5 版更改: 現(xiàn)在接受可寫的 字節(jié)類對象。

在 3.6 版更改: 添加了 setsockopt(level, optname, None, optlen: int) 調(diào)用形式。

socket.shutdown(how)?

關(guān)閉一半或全部的連接。如果 how 為 SHUT_RD，則后續(xù)不再允許接收。如果 how 為 SHUT_WR，則后續(xù)不再允許發(fā)送。如果 how 為 SHUT_RDWR，則后續(xù)的發(fā)送和接收都不允許。

socket.share(process_id)?

復(fù)制套接字，并準(zhǔn)備將其與目標(biāo)進(jìn)程共享。目標(biāo)進(jìn)程必須以 process_id 形式提供。然后可以利用某種形式的進(jìn)程間通信，將返回的字節(jié)對象傳遞給目標(biāo)進(jìn)程，還可以使用 fromshare() 在新進(jìn)程中重新創(chuàng)建套接字。一旦本方法調(diào)用完畢，就可以安全地將套接字關(guān)閉，因為操作系統(tǒng)已經(jīng)為目標(biāo)進(jìn)程復(fù)制了該套接字。

可用性: Windows。

3.3 新版功能.

注意此處沒有 read() 或 write() 方法，請使用不帶 flags 參數(shù)的 recv() 和 send() 來替代。

套接字對象還具有以下（只讀）屬性，這些屬性與傳入 socket 構(gòu)造函數(shù)的值相對應(yīng)。

socket.family?

套接字的協(xié)議簇。

socket.type?

套接字的類型。

socket.proto?

套接字的協(xié)議。

關(guān)于套接字超時的說明?

一個套接字對象可以處于以下三種模式之一：阻塞、非阻塞或超時。套接字默認(rèn)以阻塞模式創(chuàng)建，但是可以調(diào)用 setdefaulttimeout() 來更改。

• 在 blocking mode （阻塞模式）中，操作將阻塞，直到操作完成或系統(tǒng)返回錯誤（如連接超時）。

• 在 non-blocking mode （非阻塞模式）中，如果操作無法立即完成，則操作將失敗（不幸的是，不同系統(tǒng)返回的錯誤不同）：位于 select 中的函數(shù)可用于了解套接字何時以及是否可以讀取或?qū)懭搿?/p>

• 在 timeout mode （超時模式）下，如果無法在指定的超時內(nèi)完成操作（拋出 timeout 異常），或如果系統(tǒng)返回錯誤，則操作將失敗。

示例?

以下是 4 個使用 TCP/IP 協(xié)議的最小示例程序：一臺服務(wù)器，它將收到的所有數(shù)據(jù)原樣返回（僅服務(wù)于一個客戶端），還有一個使用該服務(wù)器的客戶端。注意，服務(wù)器必須按序執(zhí)行 socket(), bind(), listen(), accept() （可能需要重復(fù)執(zhí)行 accept() 以服務(wù)多個客戶端），而客戶端僅需要按序執(zhí)行 socket(), connect()。還須注意，服務(wù)器不在偵聽套接字上發(fā)送 sendall()/recv()，而是在 accept() 返回的新套接字上發(fā)送。

前兩個示例僅支持 IPv4。

# Echo server program
import socket

HOST = ''                 # Symbolic name meaning all available interfaces
PORT = 50007              # Arbitrary non-privileged port
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.bind((HOST, PORT))
    s.listen(1)
    conn, addr = s.accept()
    with conn:
        print('Connected by', addr)
        while True:
            data = conn.recv(1024)
            if not data: break
            conn.sendall(data)

# Echo client program
import socket

HOST = 'daring.cwi.nl'    # The remote host
PORT = 50007              # The same port as used by the server
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.connect((HOST, PORT))
    s.sendall(b'Hello, world')
    data = s.recv(1024)
print('Received', repr(data))

下兩個例子與上兩個很像，但是同時支持 IPv4 和 IPv6。 服務(wù)端將監(jiān)聽第一個可用的地址族（它本應(yīng)同時監(jiān)聽兩個）。 在大多數(shù)支持 IPv6 的系統(tǒng)上，IPv6 將有優(yōu)先權(quán)并且服務(wù)端可能不會接受 IPv4 流量。 客戶端將嘗試連接到作為名稱解析結(jié)果被返回的所有地址，并將流量發(fā)送給連接成功的第一個地址。

# Echo server program
import socket
import sys

HOST = None               # Symbolic name meaning all available interfaces
PORT = 50007              # Arbitrary non-privileged port
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,
                              socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except OSError as msg:
        s = None
        continue
    try:
        s.bind(sa)
        s.listen(1)
    except OSError as msg:
        s.close()
        s = None
        continue
    break
if s is None:
    print('could not open socket')
    sys.exit(1)
conn, addr = s.accept()
with conn:
    print('Connected by', addr)
    while True:
        data = conn.recv(1024)
        if not data: break
        conn.send(data)

# Echo client program
import socket
import sys

HOST = 'daring.cwi.nl'    # The remote host
PORT = 50007              # The same port as used by the server
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except OSError as msg:
        s = None
        continue
    try:
        s.connect(sa)
    except OSError as msg:
        s.close()
        s = None
        continue
    break
if s is None:
    print('could not open socket')
    sys.exit(1)
with s:
    s.sendall(b'Hello, world')
    data = s.recv(1024)
print('Received', repr(data))

下面的例子演示了如何在 Windows 上使用原始套接字編寫一個非常簡單的網(wǎng)絡(luò)嗅探器。 這個例子需要管理員權(quán)限來修改接口:

import socket

# the public network interface
HOST = socket.gethostbyname(socket.gethostname())

# create a raw socket and bind it to the public interface
s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
s.bind((HOST, 0))

# Include IP headers
s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)

# receive all packages
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)

# receive a package
print(s.recvfrom(65565))

# disabled promiscuous mode
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)

下面的例子演示了如何使用 socket 接口與采用原始套接字協(xié)議的 CAN 網(wǎng)絡(luò)進(jìn)行通信。 要改為通過廣播管理器協(xié)議來使用 CAN，則要用以下方式打開一個 socket:

socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)

在綁定 (CAN_RAW) 或連接 (CAN_BCM) socket 之后，你將可以在 socket 對象上正常使用 socket.send() 以及 socket.recv() 操作（及同類操作）。

最后一個例子可能需要特別的權(quán)限:

import socket
import struct


# CAN frame packing/unpacking (see 'struct can_frame' in <linux/can.h>)

can_frame_fmt = "=IB3x8s"
can_frame_size = struct.calcsize(can_frame_fmt)

def build_can_frame(can_id, data):
    can_dlc = len(data)
    data = data.ljust(8, b'\x00')
    return struct.pack(can_frame_fmt, can_id, can_dlc, data)

def dissect_can_frame(frame):
    can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)
    return (can_id, can_dlc, data[:can_dlc])


# create a raw socket and bind it to the 'vcan0' interface
s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
s.bind(('vcan0',))

while True:
    cf, addr = s.recvfrom(can_frame_size)

    print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))

    try:
        s.send(cf)
    except OSError:
        print('Error sending CAN frame')

    try:
        s.send(build_can_frame(0x01, b'\x01\x02\x03'))
    except OSError:
        print('Error sending CAN frame')

多次運行一個示例，且每次執(zhí)行之間等待時間過短，可能導(dǎo)致這個錯誤:

OSError: [Errno 98] Address already in use

這是因為前一次運行使套接字處于 TIME_WAIT 狀態(tài)，無法立即重用。

要防止這種情況，需要設(shè)置一個 socket 標(biāo)志 socket.SO_REUSEADDR:

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((HOST, PORT))

SO_REUSEADDR 標(biāo)志告訴內(nèi)核將處于 TIME_WAIT 狀態(tài)的本地套接字重新使用，而不必等到固有的超時到期。