Python中的asyncore(1)

在Python中，既可直接使用socket類，也可使用socketserver，asyncore等經過封裝的類來進行編碼。當然最佳方式還是twisted

《Python.In.A.Nutshell》19章第2節有關於socketserver的詳細講解，現在重點討論asyncore，這個由Python提供的Asynchronous socket handler

輸入命令pydoc asyncore就可看到該模塊的文檔說明，第一行就開宗明義的說明了該模塊的作用:

This module provides the basic infrastructure for writing asynchronous socket service clients and servers.

通過閱讀整個文檔，知道該模塊是事件驅動(event-driver)。主要方法是loop()，用於進行網絡事件的循環。而類dispatcher用於進行網絡交互事件。不能直接Instance，需要通過繼承並在__init__中顯式的聲明。它封裝了網絡的讀寫事件，並通過readable()和writable()來進行事件進行控制。

打開asyncore.py(Win32在其Python安裝目錄的lib下，Linux則在/usr/lib/python2.x下)，可以看見readable()和writable()很簡單，沒有做任何判斷，直接返回True。這都需要我們overload以控制流程及狀態，然後在handle_read()和handle_write()進行網絡數據的讀寫發送。在幫助手冊(17.5.1)裏面提供了一個基於http協議的客戶端例子，如下：

import asyncore, socket

class http_client(asyncore.dispatcher):

def __init__(self, host, path):

asyncore.dispatcher.__init__(self)

self.create_socket(socket.AF_INET,socket.SOCK_STREAM)

self.connect((host, 80))

self.buffer = 'GET %s HTTP/1.0\r\n\r\n' % path

def handle_connect(self):

pass

def handle_close(self):

self.close()

def handle_read(self):

print self.recv(8192)

def writable(self):

return (len(self.buffer) > 0)

def handle_write(self):

sent = self.send(self.buffer)

self.buffer = self.buffer[sent:]

if __name__=='__main__':

c = http_client('www.chinaunix.net', '/')

asyncore.loop()

print'Program exit'

在例子中，http_client的__init__顯式的重載了asyncore.dispatcher。接着創建了一個socket。這裏你會感覺到有些奇怪，因爲平時我們都是採用如下的格式：
s = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
s.connect((host,port))
......
很明顯，create_socket()是asyncore.dispatcher的類成員函數，它爲我們實現了上述的功能，從asyncore.py中可以看見它的原型:

def create_socket(self, family, type):

self.family_and_type = family,type

self.socket =socket.socket(family, type)

self.socket.setblocking(0)

self._fileno = self.socket.fileno()

self.add_channel()

聲明瞭一個類成員變量self.socket，讓它等於socket創建出來的描述符，並將其設置爲非阻塞，並將其添加到add_channel()中。

接着執行self.connect()函數，該函數很明顯被封裝過，可以在源碼中找到答案。需要注意的是，在說明文檔中，有這樣的一行話:

handle_connect() Implied by the first write event

當handle_connect()事件發生後，會首先調用write事件，這就不能理解爲什麼在http_client中，connect()成功後會立刻進入writable()事件，而不是隨機的進入readable()事件(當然如果實行的自定義的私有協議，服務器在對於每個連入的客戶端都發送一個歡迎信息，那麼就需要進行狀態控制，先進行讀事件)。

默認的writable()直接返回True，這裏進行了重載，用於對緩衝區進行判斷。當發現緩衝區不爲0時，就會返回True，直到緩衝區變成0，才返回False。當writable()返回True的時候，就會觸發handle_write()。該函數使用send()發送數據，並檢查每一次send的長度，以便對緩衝區進行截取，留下未發送完的數據。這樣writable()檢查到緩衝區還有數據，又會返回True，觸發handle_write()，直到把緩衝區的數據全部送完。

def writable(self):

return (len(self.buffer) > 0)

def handle_write(self):

sent = self.send(self.buffer)

self.buffer = self.buffer[sent:]

打開源碼看看self.send()的實現:

def send(self, data):

try:

result = self.socket.send(data)

return result

except socket.error, why:

if why[0] == EWOULDBLOCK:

return0

else:

raise

return0

可見self.send()並沒有一個循環數據發送動作，只是簡單的調用socket.send()，並捕獲出現的異常。該函數不保證將數據的完整發送，只會返回發送了多少。這就需要靠我們自己在外面調用時來完成(循環數據發送在異步的socket I/O裏是很常見的)。

例子中並沒有重載readable()，意味着在每個時間輪詢間隔，都允許觸發handle_read()事件。這次採用的是self.recv()函數來完成對http報文的接受。打開源碼看看self.recv()的實現:

def recv(self, buffer_size):

try:

data = self.socket.recv(buffer_size)

ifnot data:

# a closed connection is indicated by signaling

# a read condition, and having rece() return 0.

self.handle_close()

return''

else:

return data

except socket.error, why:

# winsock sometimes throws ENOTCONN

if why[0] in [ECONNRESET, ENOTCONN, ESHUTDOWN]:

self.handle_close()

return''

else:

raise

注意到文檔中對於接受和發送緩衝區都有描述:
ac_in_buffer_size
The asynchronous input buffer size (default 4096).

ac_out_buffer_size
The asynchronous output buffer size (default 4096).
緩衝區的大小是可以顯式的更改的。這裏直接使用self.recv(8192)就有點隨意了，應該從http的頭部讀出後面的數據的size，然後再進行接受。當然這並不是例子的重點