python模块SocketServer

参考http://my.oschina.net/u/1433482/blog/190612

参考http://fantefei.blog.51cto.com/2229719/1282377

服务器类型

5种类型:BaseServer,TCPServer,UnixStreamServer,UDPServer,UnixDatagramServer。 注意:BaseServer不直接对外服务。

服务器对象

  • class SocketServer.BaseServer:这是模块中的所有服务器对象的超类。它定义了接口,如下所述,但是大多数的方法不实现,在子类中进行细化。

  • BaseServer.fileno():返回服务器监听套接字的整数文件描述符。通常用来传递给select.select(), 以允许一个进程监视多个服务器。

  • BaseServer.handle_request():处理单个请求。处理顺序:get_request(), verify_request(), process_request()。如果用户提供handle()方法抛出异常,将调用服务器的handle_error()方法。如果self.timeout内没有请求收到, 将调用handle_timeout()并返回handle_request()。

  • BaseServer.serve_forever(poll_interval=0.5): 处理请求,直到一个明确的shutdown()请求。每poll_interval秒轮询一次shutdown。忽略self.timeout。如果你需要做周期性的任务,建议放置在其他线程。

  • BaseServer.shutdown():告诉serve_forever()循环停止并等待其停止。python2.6版本。

  • BaseServer.address_family: 地址家族,比如socket.AF_INET和socket.AF_UNIX。

  • BaseServer.RequestHandlerClass:用户提供的请求处理类,这个类为每个请求创建实例。

  • BaseServer.server_address:服务器侦听的地址。格式根据协议家族地址的各不相同,请参阅socket模块的文档。

  • BaseServer.socketSocket:服务器上侦听传入的请求socket对象的服务器。

服务器类支持下面的类变量:

  • BaseServer.allow_reuse_address:服务器是否允许地址的重用。默认为false ,并且可在子类中更改。

  • BaseServer.request_queue_size

请求队列的大小。如果单个请求需要很长的时间来处理,服务器忙时请求被放置到队列中,最多可以放request_queue_size个。一旦队列已满,来自客户端的请求将得到 “Connection denied”错误。默认值通常为5 ,但可以被子类覆盖。

  • BaseServer.socket_type:服务器使用的套接字类型; socket.SOCK_STREAM和socket.SOCK_DGRAM等。

  • BaseServer.timeout:超时时间,以秒为单位,或 None表示没有超时。如果handle_request()在timeout内没有收到请求,将调用handle_timeout()。

下面方法可以被子类重载,它们对服务器对象的外部用户没有影响。

  • BaseServer.finish_request():实际处理RequestHandlerClass发起的请求并调用其handle()方法。 常用。

  • BaseServer.get_request():接受socket请求,并返回二元组包含要用于与客户端通信的新socket对象,以及客户端的地址。

  • BaseServer.handle_error(request, client_address):如果RequestHandlerClass的handle()方法抛出异常时调用。默认操作是打印traceback到标准输出,并继续处理其他请求。

  • BaseServer.handle_timeout():超时处理。默认对于forking服务器是收集退出的子进程状态,threading服务器则什么都不做。

  • BaseServer.process_request(request, client_address) :调用finish_request()创建RequestHandlerClass的实例。如果需要,此功能可以创建新的进程或线程来处理请求,ForkingMixIn和ThreadingMixIn类做到这点。常用。

  • BaseServer.server_activate():通过服务器的构造函数来激活服务器。默认的行为只是监听服务器套接字。可重载。

  • BaseServer.server_bind():通过服务器的构造函数中调用绑定socket到所需的地址。可重载。

  • BaseServer.verify_request(request, client_address):返回一个布尔值,如果该值为True ,则该请求将被处理,反之请求将被拒绝。此功能可以重写来实现对服务器的访问控制。默认的实现始终返回True。client_address可以限定客户端,比如只处理指定ip区间的请求。 常用。

请求处理器

处理器接收数据并决定如何操作。它负责在socket层之上实现协议(i.e., HTTP, XML-RPC, or AMQP),读取数据,处理并写反应。可以重载的方法如下:

  • setup(): 准备请求处理. 默认什么都不做,StreamRequestHandler中会创建文件类似的对象以读写socket.

  • handle(): 处理请求。解析传入的请求,处理数据,并发送响应。默认什么都不做。常用变量:self.request,self.client_address,self.server。

  • finish(): 环境清理。默认什么都不做,如果setup产生异常,不会执行finish。

通常只需要重载handle。self.request的类型和数据报或流的服务不同。对于流服务,self.request是socket 对象;对于数据报服务,self.request是字符串和socket 。可以在子类StreamRequestHandler或DatagramRequestHandler中重载,重写setup()和finish() ,并提供self.rfile和self.wfile属性。 self.rfile和self.wfile可以读取或写入,以获得请求数据或将数据返回到客户端。

例子:

server端代码

[root@python day5]# cat tcpserver.py 
#!/usr/bin/env python
import SocketServer,time
import sys

class Myserver(SocketServer.BaseRequestHandler):
        #定义了一个用户信息字典,key是用户名,value是密码
	userinfo = {'fan':'123','te':'234','fei':'345'}
	def handle(self):
		print 'Now connect from ', self.client_address[0]
		while True:
		        #循环接收客户端发来的数据
			recvdata = self.request.recv(1024)
			if not recvdata:
				continue
			elif recvdata == 'Now client connect to Server':
				self.request.sendall('OK,I am ready')
			#如果数据是以username开头
			elif recvdata.startswith('username'):
			    #以:为分隔符,取出最后一段赋值给self.username
				self.username = recvdata.split(':')[-1]
				#判断self.username是否在字典中
				if Myserver.userinfo.has_key(self.username):
				    #用户名存在发送valid给客户端
					self.request.sendall('valid')
				else:
					self.request.sendall('invalid')
			#如果数据是以userpasswd开头
			elif recvdata.startswith('userpasswd'):
			    #以:为分隔符,取出最后一段赋值给self.userpasswd
				self.userpasswd = recvdata.split(':')[-1]
				print self.userpasswd
				#判断self.userpasswd是否正确
				if Myserver.userinfo[self.username] == self.userpasswd:
					self.request.sendall('valid')
					time.sleep(0.5)
					self.request.sendall('%s broken connect with server ' % time.strftime("5Y-%m-%d %x",time.localtime()))
					break
				else:
					self.request.sendall('invalid')
		print "broken connect with %s" % self.client_address[0]	

if __name__ == '__main__':
	try:
	    #创建一个sockerserver连接
		srv = SocketServer.ThreadingTCPServer(('127.0.0.1',8123),Myserver)
		#在后台一直运行
		srv.serve_forever()
	except	KeyboardInterrupt:
		print "CTRL+C,break"
		sys.exit()

client端代码:

[root@python day5]# cat tcpclient.py 
#!/usr/bin/env python
import socket
import time

ss = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
ss.connect(('127.0.0.1',8123))
ss.sendall('Now client connect to Server')        #发送数据到server端
aa = ss.recv(1024)                                #接收server端发过来的数据
print aa

while True:
	username = raw_input('-->username: ').strip()    #输入用户名
	ss.sendall('username:' + username )    #将用户名以特定格式发送给server端
	re = ss.recv(1024)                     #接收server端反馈回来的数据
	if re == 'valid':                      #判断输入的用户名是否正确
		break
	else:
		print "username Erroe,try again"
		continue

while True:
	userpasswd = raw_input('-->userpasswd: ').strip()
	ss.sendall('userpasswd:' + userpasswd)
	re = ss.recv(1024)
	if re == 'valid':
		print ss.recv(1024)
		break
	else:
		print 'userpasswd Error,try again'
		continue


你可能感兴趣的:(python模块SocketServer)