diff options
author | Georg Brandl <georg@python.org> | 2008-05-24 18:31:28 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2008-05-24 18:31:28 (GMT) |
commit | e152a77d96df7479ce798ebd5baee7d41af99db3 (patch) | |
tree | 3d13fa9679d1ae46e5dec0af2ddf09f6edd45561 /Doc/library/socketserver.rst | |
parent | 6acb075f03ec5ecb8d89bc56fae99dc8c5a510ab (diff) | |
download | cpython-e152a77d96df7479ce798ebd5baee7d41af99db3.zip cpython-e152a77d96df7479ce798ebd5baee7d41af99db3.tar.gz cpython-e152a77d96df7479ce798ebd5baee7d41af99db3.tar.bz2 |
socketserver renaming reversal part 3: move the module into the right
place and fix all references to it. Closes #2926.
Diffstat (limited to 'Doc/library/socketserver.rst')
-rw-r--r-- | Doc/library/socketserver.rst | 41 |
1 files changed, 20 insertions, 21 deletions
diff --git a/Doc/library/socketserver.rst b/Doc/library/socketserver.rst index d06b2c2..51cab5e 100644 --- a/Doc/library/socketserver.rst +++ b/Doc/library/socketserver.rst @@ -1,19 +1,18 @@ -:mod:`socketserver` --- A framework for network servers + +:mod:`SocketServer` --- A framework for network servers ======================================================= .. module:: SocketServer - :synopsis: Old name for the socketserver module. - -.. module:: socketserver :synopsis: A framework for network servers. .. note:: - The :mod:`SocketServer` module has been renamed to :mod:`socketserver` in - Python 3.0. It is importable under both names in Python 2.6 and the rest of - the 2.x series. + + The :mod:`SocketServer` module has been renamed to `socketserver` in Python + 3.0. The :term:`2to3` tool will automatically adapt imports when converting + your sources to 3.0. -The :mod:`socketserver` module simplifies the task of writing network servers. +The :mod:`SocketServer` module simplifies the task of writing network servers. There are four basic server classes: :class:`TCPServer` uses the Internet TCP protocol, which provides for continuous streams of data between the client and @@ -220,7 +219,7 @@ server classes like :class:`TCPServer`; these methods aren't useful to external users of the server object. .. XXX should the default implementations of these be documented, or should - it be assumed that the user will look at socketserver.py? + it be assumed that the user will look at SocketServer.py? .. function:: finish_request() @@ -325,14 +324,14 @@ request. Examples -------- -:class:`socketserver.TCPServer` Example +:class:`SocketServer.TCPServer` Example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the server side:: - import socketserver + import SocketServer - class MyTCPHandler(socketserver.BaseRequestHandler): + class MyTCPHandler(SocketServer.BaseRequestHandler): """ The RequestHandler class for our server. @@ -353,7 +352,7 @@ This is the server side:: HOST, PORT = "localhost", 9999 # Create the server, binding to localhost on port 9999 - server = socketserver.TCPServer((HOST, PORT), MyTCPHandler) + server = SocketServer.TCPServer((HOST, PORT), MyTCPHandler) # Activate the server; this will keep running until you # interrupt the program with Ctrl-C @@ -362,7 +361,7 @@ This is the server side:: An alternative request handler class that makes use of streams (file-like objects that simplify communication by providing the standard file interface):: - class MyTCPHandler(socketserver.StreamRequestHandler): + class MyTCPHandler(SocketServer.StreamRequestHandler): def handle(self): # self.rfile is a file-like object created by the handler; @@ -423,14 +422,14 @@ Client:: Received: PYTHON IS NICE -:class:`socketserver.UDPServer` Example +:class:`SocketServer.UDPServer` Example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the server side:: - import socketserver + import SocketServer - class MyUDPHandler(socketserver.BaseRequestHandler): + class MyUDPHandler(SocketServer.BaseRequestHandler): """ This class works similar to the TCP handler class, except that self.request consists of a pair of data and client socket, and since @@ -447,7 +446,7 @@ This is the server side:: if __name__ == "__main__": HOST, PORT = "localhost", 9999 - server = socketserver.UDPServer((HOST, PORT), BaseUDPRequestHandler) + server = SocketServer.UDPServer((HOST, PORT), BaseUDPRequestHandler) server.serve_forever() This is the client side:: @@ -482,9 +481,9 @@ An example for the :class:`ThreadingMixIn` class:: import socket import threading - import socketserver + import SocketServer - class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler): + class ThreadedTCPRequestHandler(SocketServer.BaseRequestHandler): def handle(self): data = self.request.recv(1024) @@ -492,7 +491,7 @@ An example for the :class:`ThreadingMixIn` class:: response = "%s: %s" % (cur_thread.getName(), data) self.request.send(response) - class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer): + class ThreadedTCPServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer): pass def client(ip, port, message): |