asynchat --- 異步套接字指令/響應處理程序?

源代碼: Lib/asynchat.py

此模塊在 asyncore 框架之上構建，簡(jiǎn)化了異步客戶(hù)端和服務(wù)器并使得處理元素為以任意字符串結束或者為可變長(cháng)度的協(xié)議更加容易。 asynchat 定義了一個(gè)可以由你來(lái)子類(lèi)化的抽象類(lèi) async_chat，提供了 collect_incoming_data() 和 found_terminator() 等方法的實(shí)現。 它使用與 asyncore 相同的異步循環(huán)，并且可以在通道映射中自由地混合 asyncore.dispatcher 和 asynchat.async_chat 這兩種類(lèi)型的通道。 一般來(lái)說(shuō) asyncore.dispatcher 服務(wù)器通道在接收到傳入的連接請求時(shí)會(huì )生成新的 asynchat.async_chat 通道對象。

class asynchat.async_chat?

這個(gè)類(lèi)是 asyncore.dispatcher 的抽象子類(lèi)。 對于實(shí)際使用的代碼你必須子類(lèi)化 async_chat，提供有意義的 collect_incoming_data() 和 found_terminator() 方法。 asyncore.dispatcher 的方法也可以被使用，但它們在消息/響應上下文中并不是全都有意義。

與 asyncore.dispatcher 類(lèi)似，async_chat 也定義了一組通過(guò)對 select() 調用之后的套接字條件進(jìn)行分析所生成的事件。 一旦啟動(dòng)輪詢(xún)循環(huán) async_chat 對象的方法就會(huì )被事件處理框架調用而無(wú)須程序員方面做任何操作。

兩個(gè)可被修改的類(lèi)屬性，用以提升性能，甚至也可能會(huì )節省內存。

ac_in_buffer_size?

異步輸入緩沖區大小 (默認為 4096)。

ac_out_buffer_size?

異步輸出緩沖區大小 (默認為 4096)。

與 asyncore.dispatcher 不同，async_chat 允許你定義一個(gè) FIFO 隊列 producers。 其中的生產(chǎn)者只需要一個(gè)方法 more()，該方法應當返回要在通道上傳輸的數據。 生產(chǎn)者通過(guò)讓其 more() 方法返回空字節串對象來(lái)表明其處于耗盡狀態(tài) (意即 它已不再包含數據)。 此時(shí) async_chat 對象會(huì )將該生產(chǎn)者從隊列中移除并開(kāi)始使用下一個(gè)生產(chǎn)者，如果有下一個(gè)的話(huà)。 當生產(chǎn)者隊列為空時(shí) handle_write() 方法將不執行任何操作。 你要使用通道對象的 set_terminator() 方法來(lái)描述如何識別來(lái)自遠程端點(diǎn)的入站傳輸的結束或是重要的中斷點(diǎn)。

要構建一個(gè)可用的 async_chat 子類(lèi)，你的輸入方法 collect_incoming_data() 和 found_terminator() 必須要處理通道異步接收的數據。 這些參數的描述見(jiàn)下文。

async_chat.close_when_done()?

將 None 推入生產(chǎn)者隊列。 當此生產(chǎn)者被彈出隊列時(shí)它將導致通道被關(guān)閉。

async_chat.collect_incoming_data(data)?

調用時(shí)附帶 data，其中包含任意數量的已接收數據。 必須被重載的默認方法將引發(fā)一個(gè) NotImplementedError 異常。

async_chat.discard_buffers()?

在緊急情況下此方法將丟棄輸入和/或輸出緩沖區以及生產(chǎn)者隊列中的任何數據。

async_chat.found_terminator()?

當輸入數據流能匹配 set_terminator() 所設定的終結條件時(shí)會(huì )被調用。 必須被重載的默認方法將引發(fā)一個(gè) NotImplementedError 異常。 被緩沖的輸入數據應當可以通過(guò)實(shí)例屬性來(lái)獲取。

async_chat.get_terminator()?

返回通道的當前終結器。

async_chat.push(data)?

將數據推入通道的隊列以確保其被傳輸。 要讓通道將數據寫(xiě)到網(wǎng)絡(luò )中你只需要這樣做就足夠了，雖然以更復雜的方式使用你自己的生產(chǎn)者也是有可能的，例如為了實(shí)現加密和分塊。

async_chat.push_with_producer(producer)?

獲取一個(gè)生產(chǎn)者對象并將其加入到與通道相關(guān)聯(lián)的生產(chǎn)者隊列中。 當所有當前已推入的生產(chǎn)者都已被耗盡時(shí)通道將通過(guò)調用其 more() 方法來(lái)耗用此生產(chǎn)者的數據并將數據發(fā)送至遠程端點(diǎn)。

async_chat.set_terminator(term)?

設置可在通道上被識別的終結條件。 term 可以是三種類(lèi)型值中的任意一種 ，對應于處理入站協(xié)議數據的三種不同方式。

term	描述
string	當在輸入流中發(fā)現該字符串時(shí)將會(huì )調用 found_terminator()
integer	當接收到指定數量的字符時(shí)將會(huì )調用 found_terminator()
None	通道會(huì )不斷地持續收集數據

請注意終結器之后的任何數據將可在 found_terminator() 被調用后由通道來(lái)讀取。

import asynchat

class http_request_handler(asynchat.async_chat):

    def __init__(self, sock, addr, sessions, log):
        asynchat.async_chat.__init__(self, sock=sock)
        self.addr = addr
        self.sessions = sessions
        self.ibuffer = []
        self.obuffer = b""
        self.set_terminator(b"\r\n\r\n")
        self.reading_headers = True
        self.handling = False
        self.cgi_data = None
        self.log = log

    def collect_incoming_data(self, data):
        """Buffer the data"""
        self.ibuffer.append(data)

    def found_terminator(self):
        if self.reading_headers:
            self.reading_headers = False
            self.parse_headers(b"".join(self.ibuffer))
            self.ibuffer = []
            if self.op.upper() == b"POST":
                clen = self.headers.getheader("content-length")
                self.set_terminator(int(clen))
            else:
                self.handling = True
                self.set_terminator(None)
                self.handle_request()
        elif not self.handling:
            self.set_terminator(None)  # browsers sometimes over-send
            self.cgi_data = parse(self.headers, b"".join(self.ibuffer))
            self.handling = True
            self.ibuffer = []
            self.handle_request()