標籤:
目錄:
異常
地址族
通訊端類型
模組方法
Socket對象與執行個體方法
socket模組提供了Python中的低層網路連接介面,用於操作通訊端操作。
異常
socket模組共定義了4種異常:
socket.error
通訊端相關的錯誤將會拋出該異常,伴隨的值是解釋錯誤資訊的字串或 (errno, string) 形式的系統調用異常返回。現在socket.error是IOError的一個子類。
socket.herror
地址相關的錯誤、C API 呼叫等可能會拋出該異常,例如使用 h_errno 的C API,比如 gethostbyname_ex() 和 gethostbyaddr() 。伴隨的值是一個 (h_errno, string) 二元組,代表一個由庫函數調用返回的錯誤, string 描述 h_errno ,由C的 hstrerror() 函數返回。
socket.gaierror
地址相關的錯誤將會拋出該異常,例如 getaddrinfo() 和 getnameinfo() 函數。伴隨的值是一個 (error, string)二元組,代表一個由庫函數調用返回的錯誤,其中string描述error,由C的 gai_strerror() 函數返回。
socket.timeout
通訊端逾時時拋出該異常。通訊端的逾時由 執行個體方法settimeout() 函數設定,目前該異常的伴隨值總是字串“timed out”。
地址族(Address Family)
地址族通常用於 socket() 函數的第一個參數,當然, AF_UNIX 只用於類UNIX平台,如果前者沒有被定義,那麼該協議對應的地址族都不可用。
socket.AF_UNIX
屬於該類型的地址就是一個字串。AF_UNIX對應的數值是:1。
socket.AF_INET
(host, port)形式的二元組。AF_INET對應的數值是:2。
socket.AF_INET6
(host, port, flowinfo, scopeid)形式的四元組。AF_INET6對應的數值是:23。
通訊端類型(Type)
通訊端類型用於 socket() 函數的第二個參數,但是只有 SOCK_STREAM 和 SOCK_DGRAM 是比較常見的。
socket.SOCK_STREAM
面向流(TCP串連)的通訊端,實際的數值是:1。
socket.SOCK_DGRAM
面向資料報(UDP串連)的通訊端,實際的數值是:2。
socket.SOCK_RAW
實際的數值是:3。
socket.SOCK_RDM
實際的數值是:4。
socket.SOCK_SEQPACKET
實際的數值是:5。
其他常量
socket.has_ipv6
布爾型的常量,顯示當前平台是否支援IPV6協議。
模組方法
socket.create_connection(addr[, timeout[, source_addr]])
socket.getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]])
至少需要兩個參數,將一個host/port資訊轉化為一個五元組,該五元組包含了一切連到目標host/port上需要的通訊端資訊。返回的五元組具有如下的形式: (family, socktype, proto, canonname, sockaddr) 。
將 host/port 參數轉化為一個包含用於建立通訊端的所有參數的5元組。host 代表網域名稱,可以是 IPv4/v6 地址或者 None。port 可以是一個服務的字串名稱如‘http‘,也可以是一個數字連接埠號碼或 None。傳遞 None 作為 host 和 port 的值等價於傳遞 NULL 給底層的 C API。
參數 family, socktype 和 proto 是可選的,預設為0,意味著選取所有的結果。參數 flags 可以是 ‘AI_*’常量中的一個或幾個,可以影響結果是如何被計算和返回的,預設值也是0。例如, AI_NUMERICHOST 會關閉網域名稱查詢,如果 host 是一個網域名稱,那麼這裡將會拋出一個異常。
該函數返回一個5元組,5元組的結構如下:
(family, socktype, proto, canonname, sockaddr)
其中 family,socktype,proto 全是整數,用於傳遞給 socket() 函數。
canonname will be a string representing the canonical name of the host if AI_CANONNAME is part of the flags argument; else canonname will be empty.
sockaddr 是一個描述通訊端地址的元組,其格式依賴於返回結果中的 family (比如 family 是 AF_INET 時 sockaddr 是一個 (address, port) 二元組;而當 family 是 AF_INET6 時 sockaddr 是一個 (address, port, flow info, scope id) 四元組),該部分的結果可以傳遞給 socket.connect() 方法。
下面的例子給出了一個擷取HTTP串連到www.python.org的80連接埠的串連資訊:
>>> socket.getaddrinfo("www.python.org", 80, 0, 0, socket.IPPROTO_TCP)[(2, 1, 6, ‘‘, (‘82.94.164.162‘, 80)), (10, 1, 6, ‘‘, (‘2001:888:2000:d::a2‘, 80, 0, 0))]
socket.getfqdn([name])
socket.gethostbyname(hostname)
將主機名稱翻譯成IPv4地址。
socket.gethostbyname_ex(hostname)
socket.gethostname()
socket.gethostbyaddr(ip_address)
socket.getnameinfo(sockaddr, flags)
socket.getprotobyname(protocolname)
socket.getservbyname(servicename[, protocolname])
socket.getservbyport(port[, protocolname])
socket.socket([family[, type[, proto]]])
socket.socketpair([family[, type[, proto]]])
socket.fromfd(fd, family, type[, proto])
socket.ntohl(x)
socket.ntohs(x)
socket.htonl(x)
socket.htons(x)
socket.inet_aton(ip_string)
socket.inet_ntoa(packed_ip)
socket.inet_pton(address_family, ip_string)
socket.inet_ntop(address_family, packed_ip)
socket.getdefaulttimeout()
socket.setdefaulttimeout(timeout)
Socket對象及對象方法
socket.accept()
作用:接受一個串連,能夠調用該方法的通訊端必須(1). 已經綁定到一個特定的地址,並且(2). 監聽串連。
傳回值: (conn, addr) 形式的二元組,其中:
conn :串連到本通訊端上來的新的通訊端對象,可以用來收發訊息。
addr :串連到本通訊端上來的通訊端對象的網路地址。
socket.bind(address)
作用:將通訊端綁定到一個地址上,前提是通訊端尚未被綁定到某個地址;
參數:符合建立該通訊端時聲明的地址族格式的地址;
傳回值:試圖綁定一個已經綁定的通訊端將拋出 socket.error 。正常調用時傳回值為空白。
socket.close()
作用:關閉通訊端,通訊端關閉後,所有針對已關閉通訊端的操作都會失敗。通訊端被GC的時候,會自動關閉。關閉通訊端會釋放串連佔用的資源,但是並不一定立刻關閉串連,如果想要及時關閉串連,應該在 close() 前調用 shutdown() 。
參數:不需要參數;
傳回值:傳回值為空白。
socket.connect(address)
作用:串連到一個遠端通訊端。
參數:符合建立該通訊端時聲明的地址族格式的地址;
傳回值:傳回值為空白。
socket.connect_ex(address)
socket.fileno()
作用:返回通訊端的fd,通訊端的fd可以用於select機制等;
參數:調用時不需要參數;
傳回值:當前通訊端的fd,windows下這個值不能用於類似 os.fdopen() 這樣直接根據fd操作的函數,類UNIX系統上沒有這個限制。
socket.getpeername()
作用:擷取該通訊端串連到的遠程通訊端的地址。
參數:調用時不需要參數;
傳回值:遠端連線通訊端的地址,具體的形式取決於通訊端的地址族。
socket.getsockname()
作用:返回某個通訊端自己的地址。
參數:調用時不需要參數;
傳回值:當前通訊端的地址,具體的形式取決於通訊端的地址族。
socket.getsockopt(level, optname[, buflen])
作用:返回給定通訊端的某些參數;
參數:
level:
optname:
buflen:
傳回值:
socket.ioctl(control, option)
socket.listen(backlog)
作用:監聽串連到該通訊端上的串連。
參數:backlog指定該通訊端可以容納的最大串連數,至少應該是0;
傳回值:傳回值為空白。
socket.makefile([mode[, bufsize]])
socket.recv(bufsize[, flags])
作用:從通訊端中接收資料
參數:
bufsize -- 最大接收的資料長度,通常應該設為2的指數次;
flags -- 預設為0,和UNIX recv(2)中的參數flags的含義相同,
傳回值:接收到的字串資料。
socket.recvfrom(bufsize[, flags])
作用:
參數:
傳回值:(string, address)形式的二元組,string是接收到的資料,address則是發送這個資料的通訊端的地址,具體的地址形式則取決於通訊端所屬的地址族。
socket.recvfrom_into(buffer[, nbytes[, flags]])
socket.recv_into(buffer[, nbytes[, flags]])
socket.send(string[, flags])
socket.sendall(string[, flags])
socket.sendto(string, address)
socket.sendto(string, flags, address)
socket.setblocking(flag)
作用:設定一個通訊端的阻塞狀態。
參數:flags -- 為0時將通訊端設為非阻塞,為1時將通訊端設為阻塞。預設情況下,初始建立的通訊端都是阻塞的。非阻塞狀態下,如果recv()函數沒有擷取到任何資料或者send()函數沒有立刻發出資料,都會拋出socket.error異常;而在阻塞模式下,這些調用會阻塞直到能夠繼續為止。 s.setblocking(0) 等價於 s.settimeout(0.0) ,而 s.setblocking(1) 等價於 s.settimeout(None) 。
傳回值:傳回值無意義。
socket.settimeout(value)
作用:
參數:
傳回值:
socket.gettimeout()
socket.setsockopt(level, optname, value)
socket.shutdown(how)
作用:關閉串連的一端或兩端一起關閉;
參數:
how -- 以何種方式關閉串連—— SHUT_RD 此後不能再讀(receive); SHUT_WR 此後不能再寫(send); SHUT_RDWR 此後不能讀寫。根據平台的不同,關閉串連的一端可能導致另一端也同樣關閉。
傳回值:
Socket對象的唯讀屬性
socket.family
對應於建立通訊端時傳入的地址族,但是顯示的是數值。
socket.type
對應於建立通訊端時傳入的通訊端類型,但是顯示的是數值。
socket.proto
Python——socket