Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : socketserver.html

<!DOCTYPE html>

<title>20.17. SocketServer — A framework for network servers &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="20.18. BaseHTTPServer — Basic HTTP server" href="basehttpserver.html" />
 <link rel="prev" title="20.16. urlparse — Parse URLs into components" href="urlparse.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/socketserver.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/socketserver.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="basehttpserver.html" title="20.18. BaseHTTPServer — Basic HTTP server"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="urlparse.html" title="20.16. urlparse — Parse URLs into components"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">20. Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">20.17. <code class="xref py py-mod docutils literal notranslate">SocketServer</code> — A framework for network servers</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-SocketServer">
<h1>20.17. <a class="reference internal" href="#module-SocketServer" title="SocketServer: A framework for network servers."><code class="xref py py-mod docutils literal notranslate">SocketServer</code></a> — A framework for network servers<a class="headerlink" href="#module-SocketServer" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
Note
The <a class="reference internal" href="#module-SocketServer" title="SocketServer: A framework for network servers."><code class="xref py py-mod docutils literal notranslate">SocketServer</code></a> module has been renamed to <code class="xref py py-mod docutils literal notranslate">socketserver</code> in
Python 3. The <a class="reference internal" href="../glossary.html#term-2to3">2to3</a> tool will automatically adapt imports when
converting your sources to Python 3.
</div>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/SocketServer.py">Lib/SocketServer.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#module-SocketServer" title="SocketServer: A framework for network servers."><code class="xref py py-mod docutils literal notranslate">SocketServer</code></a> module simplifies the task of writing network servers.
There are four basic concrete server classes:
<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.TCPServer">
class SocketServer.TCPServer(server_address, RequestHandlerClass, bind_and_activate=True)<a class="headerlink" href="#SocketServer.TCPServer" title="Permalink to this definition">¶</a></dt>
<dd>This uses the Internet TCP protocol, which provides for
continuous streams of data between the client and server.
If bind_and_activate is true, the constructor automatically attempts to
invoke <a class="reference internal" href="#SocketServer.BaseServer.server_bind" title="SocketServer.BaseServer.server_bind"><code class="xref py py-meth docutils literal notranslate">server_bind()</code></a> and
<a class="reference internal" href="#SocketServer.BaseServer.server_activate" title="SocketServer.BaseServer.server_activate"><code class="xref py py-meth docutils literal notranslate">server_activate()</code></a>. The other parameters are passed to
the <a class="reference internal" href="#SocketServer.BaseServer" title="SocketServer.BaseServer"><code class="xref py py-class docutils literal notranslate">BaseServer</code></a> base class.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.UDPServer">
class SocketServer.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)<a class="headerlink" href="#SocketServer.UDPServer" title="Permalink to this definition">¶</a></dt>
<dd>This uses datagrams, which are discrete packets of information that may
arrive out of order or be lost while in transit. The parameters are
the same as for <a class="reference internal" href="#SocketServer.TCPServer" title="SocketServer.TCPServer"><code class="xref py py-class docutils literal notranslate">TCPServer</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.UnixStreamServer">
class SocketServer.UnixStreamServer(server_address, RequestHandlerClass, bind_and_activate=True)<a class="headerlink" href="#SocketServer.UnixStreamServer" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="SocketServer.UnixDatagramServer">
class SocketServer.UnixDatagramServer(server_address, RequestHandlerClass, bind_and_activate=True)<a class="headerlink" href="#SocketServer.UnixDatagramServer" title="Permalink to this definition">¶</a></dt>
<dd>These more infrequently used classes are similar to the TCP and
UDP classes, but use Unix domain sockets; they’re not available on
non-Unix platforms. The parameters are the same as for
<a class="reference internal" href="#SocketServer.TCPServer" title="SocketServer.TCPServer"><code class="xref py py-class docutils literal notranslate">TCPServer</code></a>.
</dd></dl>

These four classes process requests synchronously; each request must be
completed before the next request can be started. This isn’t suitable if each
request takes a long time to complete, because it requires a lot of computation,
or because it returns a lot of data which the client is slow to process. The
solution is to create a separate process or thread to handle each request; the
<a class="reference internal" href="#SocketServer.ForkingMixIn" title="SocketServer.ForkingMixIn"><code class="xref py py-class docutils literal notranslate">ForkingMixIn</code></a> and <a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> mix-in classes can be used to
support asynchronous behaviour.
Creating a server requires several steps. First, you must create a request
handler class by subclassing the <a class="reference internal" href="#SocketServer.BaseRequestHandler" title="SocketServer.BaseRequestHandler"><code class="xref py py-class docutils literal notranslate">BaseRequestHandler</code></a> class and
overriding its <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method;
this method will process incoming
requests. Second, you must instantiate one of the server classes, passing it
the server’s address and the request handler class. Then call the
<a class="reference internal" href="#SocketServer.BaseServer.handle_request" title="SocketServer.BaseServer.handle_request"><code class="xref py py-meth docutils literal notranslate">handle_request()</code></a> or
<a class="reference internal" href="#SocketServer.BaseServer.serve_forever" title="SocketServer.BaseServer.serve_forever"><code class="xref py py-meth docutils literal notranslate">serve_forever()</code></a> method of the server object to
process one or many requests. Finally, call <a class="reference internal" href="#SocketServer.BaseServer.server_close" title="SocketServer.BaseServer.server_close"><code class="xref py py-meth docutils literal notranslate">server_close()</code></a>
to close the socket.
When inheriting from <a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> for threaded connection behavior,
you should explicitly declare how you want your threads to behave on an abrupt
shutdown. The <a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> class defines an attribute
daemon_threads, which indicates whether or not the server should wait for
thread termination. You should set the flag explicitly if you would like threads
to behave autonomously; the default is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>, meaning that Python will
not exit until all threads created by <a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> have exited.
Server classes have the same external methods and attributes, no matter what
network protocol they use.
<section id="server-creation-notes">
<h2>20.17.1. Server Creation Notes<a class="headerlink" href="#server-creation-notes" title="Permalink to this headline">¶</a></h2>
There are five classes in an inheritance diagram, four of which represent
synchronous servers of four types:
<div class="highlight-default notranslate"><div class="highlight"><pre>+------------+
| BaseServer |
+------------+
 |
 v
+-----------+ +------------------+
| TCPServer |-------&gt;| UnixStreamServer |
+-----------+ +------------------+
 |
 v
+-----------+ +--------------------+
| UDPServer |-------&gt;| UnixDatagramServer |
+-----------+ +--------------------+
</pre></div>
</div>
Note that <a class="reference internal" href="#SocketServer.UnixDatagramServer" title="SocketServer.UnixDatagramServer"><code class="xref py py-class docutils literal notranslate">UnixDatagramServer</code></a> derives from <a class="reference internal" href="#SocketServer.UDPServer" title="SocketServer.UDPServer"><code class="xref py py-class docutils literal notranslate">UDPServer</code></a>, not from
<a class="reference internal" href="#SocketServer.UnixStreamServer" title="SocketServer.UnixStreamServer"><code class="xref py py-class docutils literal notranslate">UnixStreamServer</code></a> — the only difference between an IP and a Unix
stream server is the address family, which is simply repeated in both Unix
server classes.
<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.ForkingMixIn">
class SocketServer.ForkingMixIn<a class="headerlink" href="#SocketServer.ForkingMixIn" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="SocketServer.ThreadingMixIn">
class SocketServer.ThreadingMixIn<a class="headerlink" href="#SocketServer.ThreadingMixIn" title="Permalink to this definition">¶</a></dt>
<dd>Forking and threading versions of each type of server can be created
using these mix-in classes. For instance, <a class="reference internal" href="#SocketServer.ThreadingUDPServer" title="SocketServer.ThreadingUDPServer"><code class="xref py py-class docutils literal notranslate">ThreadingUDPServer</code></a>
is created as follows:
<div class="highlight-default notranslate"><div class="highlight"><pre>class ThreadingUDPServer(ThreadingMixIn, UDPServer):
 pass
</pre></div>
</div>
The mix-in class comes first, since it overrides a method defined in
<a class="reference internal" href="#SocketServer.UDPServer" title="SocketServer.UDPServer"><code class="xref py py-class docutils literal notranslate">UDPServer</code></a>. Setting the various attributes also changes the
behavior of the underlying server mechanism.
<a class="reference internal" href="#SocketServer.ForkingMixIn" title="SocketServer.ForkingMixIn"><code class="xref py py-class docutils literal notranslate">ForkingMixIn</code></a> and the Forking classes mentioned below are
only available on POSIX platforms that support <a class="reference internal" href="os.html#os.fork" title="os.fork"><code class="xref py py-func docutils literal notranslate">fork()</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.ForkingTCPServer">
class SocketServer.ForkingTCPServer<a class="headerlink" href="#SocketServer.ForkingTCPServer" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="SocketServer.ForkingUDPServer">
class SocketServer.ForkingUDPServer<a class="headerlink" href="#SocketServer.ForkingUDPServer" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="SocketServer.ThreadingTCPServer">
class SocketServer.ThreadingTCPServer<a class="headerlink" href="#SocketServer.ThreadingTCPServer" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="SocketServer.ThreadingUDPServer">
class SocketServer.ThreadingUDPServer<a class="headerlink" href="#SocketServer.ThreadingUDPServer" title="Permalink to this definition">¶</a></dt>
<dd>These classes are pre-defined using the mix-in classes.
</dd></dl>

To implement a service, you must derive a class from <a class="reference internal" href="#SocketServer.BaseRequestHandler" title="SocketServer.BaseRequestHandler"><code class="xref py py-class docutils literal notranslate">BaseRequestHandler</code></a>
and redefine its <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method.
You can then run various versions of
the service by combining one of the server classes with your request handler
class. The request handler class must be different for datagram or stream
services. This can be hidden by using the handler subclasses
<a class="reference internal" href="#SocketServer.StreamRequestHandler" title="SocketServer.StreamRequestHandler"><code class="xref py py-class docutils literal notranslate">StreamRequestHandler</code></a> or <a class="reference internal" href="#SocketServer.DatagramRequestHandler" title="SocketServer.DatagramRequestHandler"><code class="xref py py-class docutils literal notranslate">DatagramRequestHandler</code></a>.
Of course, you still have to use your head! For instance, it makes no sense to
use a forking server if the service contains state in memory that can be
modified by different requests, since the modifications in the child process
would never reach the initial state kept in the parent process and passed to
each child. In this case, you can use a threading server, but you will probably
have to use locks to protect the integrity of the shared data.
On the other hand, if you are building an HTTP server where all data is stored
externally (for instance, in the file system), a synchronous class will
essentially render the service “deaf” while one request is being handled –
which may be for a very long time if a client is slow to receive all the data it
has requested. Here a threading or forking server is appropriate.
In some cases, it may be appropriate to process part of a request synchronously,
but to finish processing in a forked child depending on the request data. This
can be implemented by using a synchronous server and doing an explicit fork in
the request handler class <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method.
Another approach to handling multiple simultaneous requests in an environment
that supports neither threads nor <a class="reference internal" href="os.html#os.fork" title="os.fork"><code class="xref py py-func docutils literal notranslate">fork()</code></a> (or where these are too
expensive or inappropriate for the service) is to maintain an explicit table of
partially finished requests and to use <a class="reference internal" href="select.html#select.select" title="select.select"><code class="xref py py-func docutils literal notranslate">select()</code></a> to decide which
request to work on next (or whether to handle a new incoming request). This is
particularly important for stream services where each client can potentially be
connected for a long time (if threads or subprocesses cannot be used). See
<a class="reference internal" href="asyncore.html#module-asyncore" title="asyncore: A base class for developing asynchronous socket handling services."><code class="xref py py-mod docutils literal notranslate">asyncore</code></a> for another way to manage this.
</section>
<section id="server-objects">
<h2>20.17.2. Server Objects<a class="headerlink" href="#server-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.BaseServer">
class SocketServer.BaseServer(server_address, RequestHandlerClass)<a class="headerlink" href="#SocketServer.BaseServer" title="Permalink to this definition">¶</a></dt>
<dd>This is the superclass of all Server objects in the module. It defines the
interface, given below, but does not implement most of the methods, which is
done in subclasses. The two parameters are stored in the respective
<a class="reference internal" href="#SocketServer.BaseServer.server_address" title="SocketServer.BaseServer.server_address"><code class="xref py py-attr docutils literal notranslate">server_address</code></a> and <a class="reference internal" href="#SocketServer.BaseServer.RequestHandlerClass" title="SocketServer.BaseServer.RequestHandlerClass"><code class="xref py py-attr docutils literal notranslate">RequestHandlerClass</code></a> attributes.
<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.fileno">
fileno()<a class="headerlink" href="#SocketServer.BaseServer.fileno" title="Permalink to this definition">¶</a></dt>
<dd>Return an integer file descriptor for the socket on which the server is
listening. This function is most commonly passed to <a class="reference internal" href="select.html#select.select" title="select.select"><code class="xref py py-func docutils literal notranslate">select.select()</code></a>, to
allow monitoring multiple servers in the same process.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.handle_request">
handle_request()<a class="headerlink" href="#SocketServer.BaseServer.handle_request" title="Permalink to this definition">¶</a></dt>
<dd>Process a single request. This function calls the following methods in
order: <a class="reference internal" href="#SocketServer.BaseServer.get_request" title="SocketServer.BaseServer.get_request"><code class="xref py py-meth docutils literal notranslate">get_request()</code></a>, <a class="reference internal" href="#SocketServer.BaseServer.verify_request" title="SocketServer.BaseServer.verify_request"><code class="xref py py-meth docutils literal notranslate">verify_request()</code></a>, and
<a class="reference internal" href="#SocketServer.BaseServer.process_request" title="SocketServer.BaseServer.process_request"><code class="xref py py-meth docutils literal notranslate">process_request()</code></a>. If the user-provided
<a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method of the
handler class raises an exception, the server’s <a class="reference internal" href="#SocketServer.BaseServer.handle_error" title="SocketServer.BaseServer.handle_error"><code class="xref py py-meth docutils literal notranslate">handle_error()</code></a> method
will be called. If no request is received within <a class="reference internal" href="#SocketServer.BaseServer.timeout" title="SocketServer.BaseServer.timeout"><code class="xref py py-attr docutils literal notranslate">timeout</code></a>
seconds, <a class="reference internal" href="#SocketServer.BaseServer.handle_timeout" title="SocketServer.BaseServer.handle_timeout"><code class="xref py py-meth docutils literal notranslate">handle_timeout()</code></a> will be called and <a class="reference internal" href="#SocketServer.BaseServer.handle_request" title="SocketServer.BaseServer.handle_request"><code class="xref py py-meth docutils literal notranslate">handle_request()</code></a>
will return.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.serve_forever">
serve_forever(poll_interval=0.5)<a class="headerlink" href="#SocketServer.BaseServer.serve_forever" title="Permalink to this definition">¶</a></dt>
<dd>Handle requests until an explicit <a class="reference internal" href="#SocketServer.BaseServer.shutdown" title="SocketServer.BaseServer.shutdown"><code class="xref py py-meth docutils literal notranslate">shutdown()</code></a> request. Poll for
shutdown every poll_interval seconds.
Ignores the <a class="reference internal" href="#SocketServer.BaseServer.timeout" title="SocketServer.BaseServer.timeout"><code class="xref py py-attr docutils literal notranslate">timeout</code></a> attribute.
If you need to do periodic tasks, do them in another thread.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.shutdown">
shutdown()<a class="headerlink" href="#SocketServer.BaseServer.shutdown" title="Permalink to this definition">¶</a></dt>
<dd>Tell the <a class="reference internal" href="#SocketServer.BaseServer.serve_forever" title="SocketServer.BaseServer.serve_forever"><code class="xref py py-meth docutils literal notranslate">serve_forever()</code></a> loop to stop and wait until it does.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.server_close">
server_close()<a class="headerlink" href="#SocketServer.BaseServer.server_close" title="Permalink to this definition">¶</a></dt>
<dd>Clean up the server. May be overridden.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.address_family">
address_family<a class="headerlink" href="#SocketServer.BaseServer.address_family" title="Permalink to this definition">¶</a></dt>
<dd>The family of protocols to which the server’s socket belongs.
Common examples are <a class="reference internal" href="socket.html#socket.AF_INET" title="socket.AF_INET"><code class="xref py py-const docutils literal notranslate">socket.AF_INET</code></a> and <a class="reference internal" href="socket.html#socket.AF_UNIX" title="socket.AF_UNIX"><code class="xref py py-const docutils literal notranslate">socket.AF_UNIX</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.RequestHandlerClass">
RequestHandlerClass<a class="headerlink" href="#SocketServer.BaseServer.RequestHandlerClass" title="Permalink to this definition">¶</a></dt>
<dd>The user-provided request handler class; an instance of this class is created
for each request.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.server_address">
server_address<a class="headerlink" href="#SocketServer.BaseServer.server_address" title="Permalink to this definition">¶</a></dt>
<dd>The address on which the server is listening. The format of addresses varies
depending on the protocol family;
see the documentation for the <a class="reference internal" href="socket.html#module-socket" title="socket: Low-level networking interface."><code class="xref py py-mod docutils literal notranslate">socket</code></a> module
for details. For Internet protocols, this is a tuple containing a string giving
the address, and an integer port number: <code class="docutils literal notranslate">('127.0.0.1', 80)</code>, for example.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.socket">
socket<a class="headerlink" href="#SocketServer.BaseServer.socket" title="Permalink to this definition">¶</a></dt>
<dd>The socket object on which the server will listen for incoming requests.
</dd></dl>

The server classes support the following class variables:
<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.allow_reuse_address">
allow_reuse_address<a class="headerlink" href="#SocketServer.BaseServer.allow_reuse_address" title="Permalink to this definition">¶</a></dt>
<dd>Whether the server will allow the reuse of an address. This defaults to
<a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>, and can be set in subclasses to change the policy.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.request_queue_size">
request_queue_size<a class="headerlink" href="#SocketServer.BaseServer.request_queue_size" title="Permalink to this definition">¶</a></dt>
<dd>The size of the request queue. If it takes a long time to process a single
request, any requests that arrive while the server is busy are placed into a
queue, up to <a class="reference internal" href="#SocketServer.BaseServer.request_queue_size" title="SocketServer.BaseServer.request_queue_size"><code class="xref py py-attr docutils literal notranslate">request_queue_size</code></a> requests. Once the queue is full,
further requests from clients will get a “Connection denied” error. The default
value is usually 5, but this can be overridden by subclasses.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.socket_type">
socket_type<a class="headerlink" href="#SocketServer.BaseServer.socket_type" title="Permalink to this definition">¶</a></dt>
<dd>The type of socket used by the server; <a class="reference internal" href="socket.html#socket.SOCK_STREAM" title="socket.SOCK_STREAM"><code class="xref py py-const docutils literal notranslate">socket.SOCK_STREAM</code></a> and
<a class="reference internal" href="socket.html#socket.SOCK_DGRAM" title="socket.SOCK_DGRAM"><code class="xref py py-const docutils literal notranslate">socket.SOCK_DGRAM</code></a> are two common values.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="SocketServer.BaseServer.timeout">
timeout<a class="headerlink" href="#SocketServer.BaseServer.timeout" title="Permalink to this definition">¶</a></dt>
<dd>Timeout duration, measured in seconds, or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> if no timeout is
desired. If <a class="reference internal" href="#SocketServer.BaseServer.handle_request" title="SocketServer.BaseServer.handle_request"><code class="xref py py-meth docutils literal notranslate">handle_request()</code></a> receives no incoming requests within the
timeout period, the <a class="reference internal" href="#SocketServer.BaseServer.handle_timeout" title="SocketServer.BaseServer.handle_timeout"><code class="xref py py-meth docutils literal notranslate">handle_timeout()</code></a> method is called.
</dd></dl>

There are various server methods that can be overridden by subclasses of base
server classes like <a class="reference internal" href="#SocketServer.TCPServer" title="SocketServer.TCPServer"><code class="xref py py-class docutils literal notranslate">TCPServer</code></a>; these methods aren’t useful to external
users of the server object.
<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.finish_request">
finish_request(request, client_address)<a class="headerlink" href="#SocketServer.BaseServer.finish_request" title="Permalink to this definition">¶</a></dt>
<dd>Actually processes the request by instantiating <a class="reference internal" href="#SocketServer.BaseServer.RequestHandlerClass" title="SocketServer.BaseServer.RequestHandlerClass"><code class="xref py py-attr docutils literal notranslate">RequestHandlerClass</code></a> and
calling its <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.get_request">
get_request()<a class="headerlink" href="#SocketServer.BaseServer.get_request" title="Permalink to this definition">¶</a></dt>
<dd>Must accept a request from the socket, and return a 2-tuple containing the new
socket object to be used to communicate with the client, and the client’s
address.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.handle_error">
handle_error(request, client_address)<a class="headerlink" href="#SocketServer.BaseServer.handle_error" title="Permalink to this definition">¶</a></dt>
<dd>This function is called if the <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a>
method of a <a class="reference internal" href="#SocketServer.BaseServer.RequestHandlerClass" title="SocketServer.BaseServer.RequestHandlerClass"><code class="xref py py-attr docutils literal notranslate">RequestHandlerClass</code></a> instance raises
an exception. The default action is to print the traceback to
standard output and continue handling further requests.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.handle_timeout">
handle_timeout()<a class="headerlink" href="#SocketServer.BaseServer.handle_timeout" title="Permalink to this definition">¶</a></dt>
<dd>This function is called when the <a class="reference internal" href="#SocketServer.BaseServer.timeout" title="SocketServer.BaseServer.timeout"><code class="xref py py-attr docutils literal notranslate">timeout</code></a> attribute has been set to a
value other than <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> and the timeout period has passed with no
requests being received. The default action for forking servers is
to collect the status of any child processes that have exited, while
in threading servers this method does nothing.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.process_request">
process_request(request, client_address)<a class="headerlink" href="#SocketServer.BaseServer.process_request" title="Permalink to this definition">¶</a></dt>
<dd>Calls <a class="reference internal" href="#SocketServer.BaseServer.finish_request" title="SocketServer.BaseServer.finish_request"><code class="xref py py-meth docutils literal notranslate">finish_request()</code></a> to create an instance of the
<a class="reference internal" href="#SocketServer.BaseServer.RequestHandlerClass" title="SocketServer.BaseServer.RequestHandlerClass"><code class="xref py py-attr docutils literal notranslate">RequestHandlerClass</code></a>. If desired, this function can create a new process
or thread to handle the request; the <a class="reference internal" href="#SocketServer.ForkingMixIn" title="SocketServer.ForkingMixIn"><code class="xref py py-class docutils literal notranslate">ForkingMixIn</code></a> and
<a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> classes do this.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.server_activate">
server_activate()<a class="headerlink" href="#SocketServer.BaseServer.server_activate" title="Permalink to this definition">¶</a></dt>
<dd>Called by the server’s constructor to activate the server. The default behavior
for a TCP server just invokes <a class="reference internal" href="socket.html#socket.socket.listen" title="socket.socket.listen"><code class="xref py py-meth docutils literal notranslate">listen()</code></a>
on the server’s socket. May be overridden.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.server_bind">
server_bind()<a class="headerlink" href="#SocketServer.BaseServer.server_bind" title="Permalink to this definition">¶</a></dt>
<dd>Called by the server’s constructor to bind the socket to the desired address.
May be overridden.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseServer.verify_request">
verify_request(request, client_address)<a class="headerlink" href="#SocketServer.BaseServer.verify_request" title="Permalink to this definition">¶</a></dt>
<dd>Must return a Boolean value; if the value is <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>, the request will be
processed, and if it’s <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>, the request will be denied. This function
can be overridden to implement access controls for a server. The default
implementation always returns <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>.
</dd></dl>

</dd></dl>

</section>
<section id="request-handler-objects">
<h2>20.17.3. Request Handler Objects<a class="headerlink" href="#request-handler-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.BaseRequestHandler">
class SocketServer.BaseRequestHandler<a class="headerlink" href="#SocketServer.BaseRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>This is the superclass of all request handler objects. It defines
the interface, given below. A concrete request handler subclass must
define a new <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method, and can override any of
the other methods. A new instance of the subclass is created for each
request.
<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseRequestHandler.setup">
setup()<a class="headerlink" href="#SocketServer.BaseRequestHandler.setup" title="Permalink to this definition">¶</a></dt>
<dd>Called before the <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method to perform any initialization actions
required. The default implementation does nothing.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseRequestHandler.handle">
handle()<a class="headerlink" href="#SocketServer.BaseRequestHandler.handle" title="Permalink to this definition">¶</a></dt>
<dd>This function must do all the work required to service a request. The
default implementation does nothing. Several instance attributes are
available to it; the request is available as <code class="xref py py-attr docutils literal notranslate">self.request</code>; the client
address as <code class="xref py py-attr docutils literal notranslate">self.client_address</code>; and the server instance as
<code class="xref py py-attr docutils literal notranslate">self.server</code>, in case it needs access to per-server information.
The type of <code class="xref py py-attr docutils literal notranslate">self.request</code> is different for datagram or stream
services. For stream services, <code class="xref py py-attr docutils literal notranslate">self.request</code> is a socket object; for
datagram services, <code class="xref py py-attr docutils literal notranslate">self.request</code> is a pair of string and socket.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="SocketServer.BaseRequestHandler.finish">
finish()<a class="headerlink" href="#SocketServer.BaseRequestHandler.finish" title="Permalink to this definition">¶</a></dt>
<dd>Called after the <a class="reference internal" href="#SocketServer.BaseRequestHandler.handle" title="SocketServer.BaseRequestHandler.handle"><code class="xref py py-meth docutils literal notranslate">handle()</code></a> method to perform any clean-up actions
required. The default implementation does nothing. If <a class="reference internal" href="#SocketServer.BaseRequestHandler.setup" title="SocketServer.BaseRequestHandler.setup"><code class="xref py py-meth docutils literal notranslate">setup()</code></a>
raises an exception, this function will not be called.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="SocketServer.StreamRequestHandler">
class SocketServer.StreamRequestHandler<a class="headerlink" href="#SocketServer.StreamRequestHandler" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="SocketServer.DatagramRequestHandler">
class SocketServer.DatagramRequestHandler<a class="headerlink" href="#SocketServer.DatagramRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>These <a class="reference internal" href="#SocketServer.BaseRequestHandler" title="SocketServer.BaseRequestHandler"><code class="xref py py-class docutils literal notranslate">BaseRequestHandler</code></a> subclasses override the
<a class="reference internal" href="#SocketServer.BaseRequestHandler.setup" title="SocketServer.BaseRequestHandler.setup"><code class="xref py py-meth docutils literal notranslate">setup()</code></a> and <a class="reference internal" href="#SocketServer.BaseRequestHandler.finish" title="SocketServer.BaseRequestHandler.finish"><code class="xref py py-meth docutils literal notranslate">finish()</code></a>
methods, and provide <code class="xref py py-attr docutils literal notranslate">self.rfile</code> and <code class="xref py py-attr docutils literal notranslate">self.wfile</code> attributes.
The <code class="xref py py-attr docutils literal notranslate">self.rfile</code> and <code class="xref py py-attr docutils literal notranslate">self.wfile</code> attributes can be
read or written, respectively, to get the request data or return data
to the client.
</dd></dl>

</section>
<section id="examples">
<h2>20.17.4. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<section id="socketserver-tcpserver-example">
<h3>20.17.4.1. <a class="reference internal" href="#SocketServer.TCPServer" title="SocketServer.TCPServer"><code class="xref py py-class docutils literal notranslate">SocketServer.TCPServer</code></a> Example<a class="headerlink" href="#socketserver-tcpserver-example" title="Permalink to this headline">¶</a></h3>
This is the server side:
<div class="highlight-default notranslate"><div class="highlight"><pre>import SocketServer

class MyTCPHandler(SocketServer.BaseRequestHandler):
 &quot;&quot;&quot;
 The request handler class for our server.

It is instantiated once per connection to the server, and must
 override the handle() method to implement communication to the
 client.
 &quot;&quot;&quot;

def handle(self):
 # self.request is the TCP socket connected to the client
 self.data = self.request.recv(1024).strip()
 print &quot;{} wrote:&quot;.format(self.client_address[0])
 print self.data
 # just send back the same data, but upper-cased
 self.request.sendall(self.data.upper())

# Create the server, binding to localhost on port 9999
 server = SocketServer.TCPServer((HOST, PORT), MyTCPHandler)

# Activate the server; this will keep running until you
 # interrupt the program with Ctrl-C
 server.serve_forever()
</pre></div>
</div>
An alternative request handler class that makes use of streams (file-like
objects that simplify communication by providing the standard file interface):
<div class="highlight-default notranslate"><div class="highlight"><pre>class MyTCPHandler(SocketServer.StreamRequestHandler):

def handle(self):
 # self.rfile is a file-like object created by the handler;
 # we can now use e.g. readline() instead of raw recv() calls
 self.data = self.rfile.readline().strip()
 print &quot;{} wrote:&quot;.format(self.client_address[0])
 print self.data
 # Likewise, self.wfile is a file-like object used to write back
 # to the client
 self.wfile.write(self.data.upper())
</pre></div>
</div>
The difference is that the <code class="docutils literal notranslate">readline()</code> call in the second handler will call
<code class="docutils literal notranslate">recv()</code> multiple times until it encounters a newline character, while the
single <code class="docutils literal notranslate">recv()</code> call in the first handler will just return what has been sent
from the client in one <code class="docutils literal notranslate">sendall()</code> call.
This is the client side:
<div class="highlight-default notranslate"><div class="highlight"><pre>import socket
import sys

HOST, PORT = &quot;localhost&quot;, 9999
data = &quot; &quot;.join(sys.argv[1:])

# Create a socket (SOCK_STREAM means a TCP socket)
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

try:
 # Connect to server and send data
 sock.connect((HOST, PORT))
 sock.sendall(data + &quot;\n&quot;)

# Receive data from the server and shut down
 received = sock.recv(1024)
finally:
 sock.close()

print &quot;Sent: {}&quot;.format(data)
print &quot;Received: {}&quot;.format(received)
</pre></div>
</div>
The output of the example should look something like this:
Server:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python TCPServer.py
127.0.0.1 wrote:
hello world with TCP
127.0.0.1 wrote:
python is nice
</pre></div>
</div>
Client:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python TCPClient.py hello world with TCP
Sent: hello world with TCP
Received: HELLO WORLD WITH TCP
$ python TCPClient.py python is nice
Sent: python is nice
Received: PYTHON IS NICE
</pre></div>
</div>
</section>
<section id="socketserver-udpserver-example">
<h3>20.17.4.2. <a class="reference internal" href="#SocketServer.UDPServer" title="SocketServer.UDPServer"><code class="xref py py-class docutils literal notranslate">SocketServer.UDPServer</code></a> Example<a class="headerlink" href="#socketserver-udpserver-example" title="Permalink to this headline">¶</a></h3>
This is the server side:
<div class="highlight-default notranslate"><div class="highlight"><pre>import SocketServer

class MyUDPHandler(SocketServer.BaseRequestHandler):
 &quot;&quot;&quot;
 This class works similar to the TCP handler class, except that
 self.request consists of a pair of data and client socket, and since
 there is no connection the client address must be given explicitly
 when sending data back via sendto().
 &quot;&quot;&quot;

def handle(self):
 data = self.request[0].strip()
 socket = self.request[1]
 print &quot;{} wrote:&quot;.format(self.client_address[0])
 print data
 socket.sendto(data.upper(), self.client_address)

if __name__ == &quot;__main__&quot;:
 HOST, PORT = &quot;localhost&quot;, 9999
 server = SocketServer.UDPServer((HOST, PORT), MyUDPHandler)
 server.serve_forever()
</pre></div>
</div>
This is the client side:
<div class="highlight-default notranslate"><div class="highlight"><pre>import socket
import sys

# SOCK_DGRAM is the socket type to use for UDP sockets
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

# As you can see, there is no connect() call; UDP has no connections.
# Instead, data is directly sent to the recipient via sendto().
sock.sendto(data + &quot;\n&quot;, (HOST, PORT))
received = sock.recv(1024)

print &quot;Sent: {}&quot;.format(data)
print &quot;Received: {}&quot;.format(received)
</pre></div>
</div>
The output of the example should look exactly like for the TCP server example.
</section>
<section id="asynchronous-mixins">
<h3>20.17.4.3. Asynchronous Mixins<a class="headerlink" href="#asynchronous-mixins" title="Permalink to this headline">¶</a></h3>
To build asynchronous handlers, use the <a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> and
<a class="reference internal" href="#SocketServer.ForkingMixIn" title="SocketServer.ForkingMixIn"><code class="xref py py-class docutils literal notranslate">ForkingMixIn</code></a> classes.
An example for the <a class="reference internal" href="#SocketServer.ThreadingMixIn" title="SocketServer.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate">ThreadingMixIn</code></a> class:
<div class="highlight-default notranslate"><div class="highlight"><pre>import socket
import threading
import SocketServer

class ThreadedTCPRequestHandler(SocketServer.BaseRequestHandler):

def handle(self):
 data = self.request.recv(1024)
 cur_thread = threading.current_thread()
 response = &quot;{}: {}&quot;.format(cur_thread.name, data)
 self.request.sendall(response)

class ThreadedTCPServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer):
 pass

def client(ip, port, message):
 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 sock.connect((ip, port))
 try:
 sock.sendall(message)
 response = sock.recv(1024)
 print &quot;Received: {}&quot;.format(response)
 finally:
 sock.close()

server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
 ip, port = server.server_address

# Start a thread with the server -- that thread will then start one
 # more thread for each request
 server_thread = threading.Thread(target=server.serve_forever)
 # Exit the server thread when the main thread terminates
 server_thread.daemon = True
 server_thread.start()
 print &quot;Server loop running in thread:&quot;, server_thread.name

client(ip, port, &quot;Hello World 1&quot;)
 client(ip, port, &quot;Hello World 2&quot;)
 client(ip, port, &quot;Hello World 3&quot;)

server.shutdown()
 server.server_close()
</pre></div>
</div>
The output of the example should look something like this:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python ThreadedTCPServer.py
Server loop running in thread: Thread-1
Received: Thread-2: Hello World 1
Received: Thread-3: Hello World 2
Received: Thread-4: Hello World 3
</pre></div>
</div>
The <a class="reference internal" href="#SocketServer.ForkingMixIn" title="SocketServer.ForkingMixIn"><code class="xref py py-class docutils literal notranslate">ForkingMixIn</code></a> class is used in the same way, except that the server
will spawn a new process for each request.
Available only on POSIX platforms that support <a class="reference internal" href="os.html#os.fork" title="os.fork"><code class="xref py py-func docutils literal notranslate">fork()</code></a>.
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">20.17. <code class="xref py py-mod docutils literal notranslate">SocketServer</code> — A framework for network servers</a><ul>
<li><a class="reference internal" href="#server-creation-notes">20.17.1. Server Creation Notes</a></li>
<li><a class="reference internal" href="#server-objects">20.17.2. Server Objects</a></li>
<li><a class="reference internal" href="#request-handler-objects">20.17.3. Request Handler Objects</a></li>
<li><a class="reference internal" href="#examples">20.17.4. Examples</a><ul>
<li><a class="reference internal" href="#socketserver-tcpserver-example">20.17.4.1. <code class="xref py py-class docutils literal notranslate">SocketServer.TCPServer</code> Example</a></li>
<li><a class="reference internal" href="#socketserver-udpserver-example">20.17.4.2. <code class="xref py py-class docutils literal notranslate">SocketServer.UDPServer</code> Example</a></li>
<li><a class="reference internal" href="#asynchronous-mixins">20.17.4.3. Asynchronous Mixins</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="urlparse.html"
 title="previous chapter">20.16. <code class="xref py py-mod docutils literal notranslate">urlparse</code> — Parse URLs into components</a>
 <h4>Next topic</h4>
 <a href="basehttpserver.html"
 title="next chapter">20.18. <code class="xref py py-mod docutils literal notranslate">BaseHTTPServer</code> — Basic HTTP server</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/socketserver.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="basehttpserver.html" title="20.18. BaseHTTPServer — Basic HTTP server"
 >next</a> |</li>
 <li class="right" >
 <a href="urlparse.html" title="20.16. urlparse — Parse URLs into components"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" >20. Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">20.17. <code class="xref py py-mod docutils literal notranslate">SocketServer</code> — A framework for network servers</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : socketserver.html