Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : asyncio-protocol.html

<!DOCTYPE html>

<title>Transports and Protocols &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <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 3.10.12 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="Policies" href="asyncio-policy.html" />
 <link rel="prev" title="Futures" href="asyncio-future.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/asyncio-protocol.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Transports and Protocols</a><ul>
<li><a class="reference internal" href="#transports">Transports</a><ul>
<li><a class="reference internal" href="#transports-hierarchy">Transports Hierarchy</a></li>
<li><a class="reference internal" href="#base-transport">Base Transport</a></li>
<li><a class="reference internal" href="#read-only-transports">Read-only Transports</a></li>
<li><a class="reference internal" href="#write-only-transports">Write-only Transports</a></li>
<li><a class="reference internal" href="#datagram-transports">Datagram Transports</a></li>
<li><a class="reference internal" href="#subprocess-transports">Subprocess Transports</a></li>
</ul>
</li>
<li><a class="reference internal" href="#protocols">Protocols</a><ul>
<li><a class="reference internal" href="#base-protocols">Base Protocols</a></li>
<li><a class="reference internal" href="#base-protocol">Base Protocol</a></li>
<li><a class="reference internal" href="#streaming-protocols">Streaming Protocols</a></li>
<li><a class="reference internal" href="#buffered-streaming-protocols">Buffered Streaming Protocols</a></li>
<li><a class="reference internal" href="#datagram-protocols">Datagram Protocols</a></li>
<li><a class="reference internal" href="#subprocess-protocols">Subprocess Protocols</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#tcp-echo-server">TCP Echo Server</a></li>
<li><a class="reference internal" href="#tcp-echo-client">TCP Echo Client</a></li>
<li><a class="reference internal" href="#udp-echo-server">UDP Echo Server</a></li>
<li><a class="reference internal" href="#udp-echo-client">UDP Echo Client</a></li>
<li><a class="reference internal" href="#connecting-existing-sockets">Connecting Existing Sockets</a></li>
<li><a class="reference internal" href="#loop-subprocess-exec-and-subprocessprotocol">loop.subprocess_exec() and SubprocessProtocol</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<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="asyncio-policy.html" title="Policies"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="asyncio-future.html" title="Futures"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 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="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>
 <li class="nav-item nav-item-3"><a href="asyncio.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate">asyncio</code> — Asynchronous I/O</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Transports and Protocols</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="transports-and-protocols">
<h1>Transports and Protocols<a class="headerlink" href="#transports-and-protocols" title="Permalink to this headline">¶</a></h1>
Preface
Transports and Protocols are used by the low-level event loop
APIs such as <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_connection" title="asyncio.loop.create_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_connection()</code></a>. They use
callback-based programming style and enable high-performance
implementations of network or IPC protocols (e.g. HTTP).
Essentially, transports and protocols should only be used in
libraries and frameworks and never in high-level asyncio
applications.
This documentation page covers both <a class="reference internal" href="#transports">Transports</a> and <a class="reference internal" href="#protocols">Protocols</a>.
Introduction
At the highest level, the transport is concerned with how bytes
are transmitted, while the protocol determines which bytes to
transmit (and to some extent when).
A different way of saying the same thing: a transport is an
abstraction for a socket (or similar I/O endpoint) while a protocol
is an abstraction for an application, from the transport’s point
of view.
Yet another view is the transport and protocol interfaces
together define an abstract interface for using network I/O and
interprocess I/O.
There is always a 1:1 relationship between transport and protocol
objects: the protocol calls transport methods to send data,
while the transport calls protocol methods to pass it data that
has been received.
Most of connection oriented event loop methods
(such as <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_connection" title="asyncio.loop.create_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_connection()</code></a>) usually accept a
protocol_factory argument used to create a Protocol object
for an accepted connection, represented by a Transport object.
Such methods usually return a tuple of <code class="docutils literal notranslate">(transport, protocol)</code>.
Contents
This documentation page contains the following sections:
<ul class="simple">
<li>The <a class="reference internal" href="#transports">Transports</a> section documents asyncio <a class="reference internal" href="#asyncio.BaseTransport" title="asyncio.BaseTransport"><code class="xref py py-class docutils literal notranslate">BaseTransport</code></a>,
<a class="reference internal" href="#asyncio.ReadTransport" title="asyncio.ReadTransport"><code class="xref py py-class docutils literal notranslate">ReadTransport</code></a>, <a class="reference internal" href="#asyncio.WriteTransport" title="asyncio.WriteTransport"><code class="xref py py-class docutils literal notranslate">WriteTransport</code></a>, <a class="reference internal" href="#asyncio.Transport" title="asyncio.Transport"><code class="xref py py-class docutils literal notranslate">Transport</code></a>,
<a class="reference internal" href="#asyncio.DatagramTransport" title="asyncio.DatagramTransport"><code class="xref py py-class docutils literal notranslate">DatagramTransport</code></a>, and <a class="reference internal" href="#asyncio.SubprocessTransport" title="asyncio.SubprocessTransport"><code class="xref py py-class docutils literal notranslate">SubprocessTransport</code></a>
classes.</li>
<li>The <a class="reference internal" href="#protocols">Protocols</a> section documents asyncio <a class="reference internal" href="#asyncio.BaseProtocol" title="asyncio.BaseProtocol"><code class="xref py py-class docutils literal notranslate">BaseProtocol</code></a>,
<a class="reference internal" href="#asyncio.Protocol" title="asyncio.Protocol"><code class="xref py py-class docutils literal notranslate">Protocol</code></a>, <a class="reference internal" href="#asyncio.BufferedProtocol" title="asyncio.BufferedProtocol"><code class="xref py py-class docutils literal notranslate">BufferedProtocol</code></a>,
<a class="reference internal" href="#asyncio.DatagramProtocol" title="asyncio.DatagramProtocol"><code class="xref py py-class docutils literal notranslate">DatagramProtocol</code></a>, and <a class="reference internal" href="#asyncio.SubprocessProtocol" title="asyncio.SubprocessProtocol"><code class="xref py py-class docutils literal notranslate">SubprocessProtocol</code></a> classes.</li>
<li>The <a class="reference internal" href="#examples">Examples</a> section showcases how to work with transports,
protocols, and low-level event loop APIs.</li>
</ul>
<section id="transports">
<h2>Transports<a class="headerlink" href="#transports" title="Permalink to this headline">¶</a></h2>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/asyncio/transports.py">Lib/asyncio/transports.py</a>
<hr class="docutils" />
Transports are classes provided by <a class="reference internal" href="asyncio.html#module-asyncio" title="asyncio: Asynchronous I/O."><code class="xref py py-mod docutils literal notranslate">asyncio</code></a> in order to abstract
various kinds of communication channels.
Transport objects are always instantiated by an
<a class="reference internal" href="asyncio-eventloop.html#asyncio-event-loop">asyncio event loop</a>.
asyncio implements transports for TCP, UDP, SSL, and subprocess pipes.
The methods available on a transport depend on the transport’s kind.
The transport classes are <a class="reference internal" href="asyncio-dev.html#asyncio-multithreading">not thread safe</a>.
<section id="transports-hierarchy">
<h3>Transports Hierarchy<a class="headerlink" href="#transports-hierarchy" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="asyncio.BaseTransport">
class asyncio.BaseTransport<a class="headerlink" href="#asyncio.BaseTransport" title="Permalink to this definition">¶</a></dt>
<dd>Base class for all transports. Contains methods that all
asyncio transports share.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.WriteTransport">
class asyncio.WriteTransport(BaseTransport)<a class="headerlink" href="#asyncio.WriteTransport" title="Permalink to this definition">¶</a></dt>
<dd>A base transport for write-only connections.
Instances of the WriteTransport class are returned from
the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.connect_write_pipe" title="asyncio.loop.connect_write_pipe"><code class="xref py py-meth docutils literal notranslate">loop.connect_write_pipe()</code></a> event loop method and
are also used by subprocess-related methods like
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_exec" title="asyncio.loop.subprocess_exec"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_exec()</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.ReadTransport">
class asyncio.ReadTransport(BaseTransport)<a class="headerlink" href="#asyncio.ReadTransport" title="Permalink to this definition">¶</a></dt>
<dd>A base transport for read-only connections.
Instances of the ReadTransport class are returned from
the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.connect_read_pipe" title="asyncio.loop.connect_read_pipe"><code class="xref py py-meth docutils literal notranslate">loop.connect_read_pipe()</code></a> event loop method and
are also used by subprocess-related methods like
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_exec" title="asyncio.loop.subprocess_exec"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_exec()</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.Transport">
class asyncio.Transport(WriteTransport, ReadTransport)<a class="headerlink" href="#asyncio.Transport" title="Permalink to this definition">¶</a></dt>
<dd>Interface representing a bidirectional transport, such as a
TCP connection.
The user does not instantiate a transport directly; they call a
utility function, passing it a protocol factory and other
information necessary to create the transport and protocol.
Instances of the Transport class are returned from or used by
event loop methods like <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_connection" title="asyncio.loop.create_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_connection()</code></a>,
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_unix_connection" title="asyncio.loop.create_unix_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_unix_connection()</code></a>,
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_server" title="asyncio.loop.create_server"><code class="xref py py-meth docutils literal notranslate">loop.create_server()</code></a>, <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.sendfile" title="asyncio.loop.sendfile"><code class="xref py py-meth docutils literal notranslate">loop.sendfile()</code></a>, etc.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.DatagramTransport">
class asyncio.DatagramTransport(BaseTransport)<a class="headerlink" href="#asyncio.DatagramTransport" title="Permalink to this definition">¶</a></dt>
<dd>A transport for datagram (UDP) connections.
Instances of the DatagramTransport class are returned from
the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="asyncio.loop.create_datagram_endpoint"><code class="xref py py-meth docutils literal notranslate">loop.create_datagram_endpoint()</code></a> event loop method.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport">
class asyncio.SubprocessTransport(BaseTransport)<a class="headerlink" href="#asyncio.SubprocessTransport" title="Permalink to this definition">¶</a></dt>
<dd>An abstraction to represent a connection between a parent and its
child OS process.
Instances of the SubprocessTransport class are returned from
event loop methods <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_shell" title="asyncio.loop.subprocess_shell"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_shell()</code></a> and
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_exec" title="asyncio.loop.subprocess_exec"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_exec()</code></a>.
</dd></dl>

</section>
<section id="base-transport">
<h3>Base Transport<a class="headerlink" href="#base-transport" title="Permalink to this headline">¶</a></h3>
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseTransport.close">
BaseTransport.close()<a class="headerlink" href="#asyncio.BaseTransport.close" title="Permalink to this definition">¶</a></dt>
<dd>Close the transport.
If the transport has a buffer for outgoing
data, buffered data will be flushed asynchronously. No more data
will be received. After all buffered data is flushed, the
protocol’s <a class="reference internal" href="#asyncio.BaseProtocol.connection_lost" title="asyncio.BaseProtocol.connection_lost"><code class="xref py py-meth docutils literal notranslate">protocol.connection_lost()</code></a> method will be called with
<a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> as its argument. The transport should not be
used once it is closed.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseTransport.is_closing">
BaseTransport.is_closing()<a class="headerlink" href="#asyncio.BaseTransport.is_closing" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the transport is closing or is closed.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseTransport.get_extra_info">
BaseTransport.get_extra_info(name, default=None)<a class="headerlink" href="#asyncio.BaseTransport.get_extra_info" title="Permalink to this definition">¶</a></dt>
<dd>Return information about the transport or underlying resources
it uses.
name is a string representing the piece of transport-specific
information to get.
default is the value to return if the information is not
available, or if the transport does not support querying it
with the given third-party event loop implementation or on the
current platform.
For example, the following code attempts to get the underlying
socket object of the transport:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>sock = transport.get_extra_info(&#39;socket&#39;)
if sock is not None:
 print(sock.getsockopt(...))
</pre></div>
</div>
Categories of information that can be queried on some transports:
<ul class="simple">
<li>socket:
<ul>
<li><code class="docutils literal notranslate">'peername'</code>: the remote address to which the socket is
connected, result of <a class="reference internal" href="socket.html#socket.socket.getpeername" title="socket.socket.getpeername"><code class="xref py py-meth docutils literal notranslate">socket.socket.getpeername()</code></a>
(<code class="docutils literal notranslate">None</code> on error)</li>
<li><code class="docutils literal notranslate">'socket'</code>: <a class="reference internal" href="socket.html#socket.socket" title="socket.socket"><code class="xref py py-class docutils literal notranslate">socket.socket</code></a> instance</li>
<li><code class="docutils literal notranslate">'sockname'</code>: the socket’s own address,
result of <a class="reference internal" href="socket.html#socket.socket.getsockname" title="socket.socket.getsockname"><code class="xref py py-meth docutils literal notranslate">socket.socket.getsockname()</code></a></li>
</ul>
</li>
<li>SSL socket:
<ul>
<li><code class="docutils literal notranslate">'compression'</code>: the compression algorithm being used as a
string, or <code class="docutils literal notranslate">None</code> if the connection isn’t compressed; result
of <a class="reference internal" href="ssl.html#ssl.SSLSocket.compression" title="ssl.SSLSocket.compression"><code class="xref py py-meth docutils literal notranslate">ssl.SSLSocket.compression()</code></a></li>
<li><code class="docutils literal notranslate">'cipher'</code>: a three-value tuple containing the name of the
cipher being used, the version of the SSL protocol that defines
its use, and the number of secret bits being used; result of
<a class="reference internal" href="ssl.html#ssl.SSLSocket.cipher" title="ssl.SSLSocket.cipher"><code class="xref py py-meth docutils literal notranslate">ssl.SSLSocket.cipher()</code></a></li>
<li><code class="docutils literal notranslate">'peercert'</code>: peer certificate; result of
<a class="reference internal" href="ssl.html#ssl.SSLSocket.getpeercert" title="ssl.SSLSocket.getpeercert"><code class="xref py py-meth docutils literal notranslate">ssl.SSLSocket.getpeercert()</code></a></li>
<li><code class="docutils literal notranslate">'sslcontext'</code>: <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate">ssl.SSLContext</code></a> instance</li>
<li><code class="docutils literal notranslate">'ssl_object'</code>: <a class="reference internal" href="ssl.html#ssl.SSLObject" title="ssl.SSLObject"><code class="xref py py-class docutils literal notranslate">ssl.SSLObject</code></a> or
<a class="reference internal" href="ssl.html#ssl.SSLSocket" title="ssl.SSLSocket"><code class="xref py py-class docutils literal notranslate">ssl.SSLSocket</code></a> instance</li>
</ul>
</li>
<li>pipe:
<ul>
<li><code class="docutils literal notranslate">'pipe'</code>: pipe object</li>
</ul>
</li>
<li>subprocess:
<ul>
<li><code class="docutils literal notranslate">'subprocess'</code>: <a class="reference internal" href="subprocess.html#subprocess.Popen" title="subprocess.Popen"><code class="xref py py-class docutils literal notranslate">subprocess.Popen</code></a> instance</li>
</ul>
</li>
</ul>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseTransport.set_protocol">
BaseTransport.set_protocol(protocol)<a class="headerlink" href="#asyncio.BaseTransport.set_protocol" title="Permalink to this definition">¶</a></dt>
<dd>Set a new protocol.
Switching protocol should only be done when both
protocols are documented to support the switch.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseTransport.get_protocol">
BaseTransport.get_protocol()<a class="headerlink" href="#asyncio.BaseTransport.get_protocol" title="Permalink to this definition">¶</a></dt>
<dd>Return the current protocol.
</dd></dl>

</section>
<section id="read-only-transports">
<h3>Read-only Transports<a class="headerlink" href="#read-only-transports" title="Permalink to this headline">¶</a></h3>
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.ReadTransport.is_reading">
ReadTransport.is_reading()<a class="headerlink" href="#asyncio.ReadTransport.is_reading" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the transport is receiving new data.
<div class="versionadded">
New in version 3.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.ReadTransport.pause_reading">
ReadTransport.pause_reading()<a class="headerlink" href="#asyncio.ReadTransport.pause_reading" title="Permalink to this definition">¶</a></dt>
<dd>Pause the receiving end of the transport. No data will be passed to
the protocol’s <a class="reference internal" href="#asyncio.Protocol.data_received" title="asyncio.Protocol.data_received"><code class="xref py py-meth docutils literal notranslate">protocol.data_received()</code></a>
method until <a class="reference internal" href="#asyncio.ReadTransport.resume_reading" title="asyncio.ReadTransport.resume_reading"><code class="xref py py-meth docutils literal notranslate">resume_reading()</code></a> is called.
<div class="versionchanged">
Changed in version 3.7: The method is idempotent, i.e. it can be called when the
transport is already paused or closed.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.ReadTransport.resume_reading">
ReadTransport.resume_reading()<a class="headerlink" href="#asyncio.ReadTransport.resume_reading" title="Permalink to this definition">¶</a></dt>
<dd>Resume the receiving end. The protocol’s
<a class="reference internal" href="#asyncio.Protocol.data_received" title="asyncio.Protocol.data_received"><code class="xref py py-meth docutils literal notranslate">protocol.data_received()</code></a> method
will be called once again if some data is available for reading.
<div class="versionchanged">
Changed in version 3.7: The method is idempotent, i.e. it can be called when the
transport is already reading.
</div>
</dd></dl>

</section>
<section id="write-only-transports">
<h3>Write-only Transports<a class="headerlink" href="#write-only-transports" title="Permalink to this headline">¶</a></h3>
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.abort">
WriteTransport.abort()<a class="headerlink" href="#asyncio.WriteTransport.abort" title="Permalink to this definition">¶</a></dt>
<dd>Close the transport immediately, without waiting for pending operations
to complete. Buffered data will be lost. No more data will be received.
The protocol’s <a class="reference internal" href="#asyncio.BaseProtocol.connection_lost" title="asyncio.BaseProtocol.connection_lost"><code class="xref py py-meth docutils literal notranslate">protocol.connection_lost()</code></a> method will eventually be
called with <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> as its argument.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.can_write_eof">
WriteTransport.can_write_eof()<a class="headerlink" href="#asyncio.WriteTransport.can_write_eof" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if the transport supports
<a class="reference internal" href="#asyncio.WriteTransport.write_eof" title="asyncio.WriteTransport.write_eof"><code class="xref py py-meth docutils literal notranslate">write_eof()</code></a>, <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a> if not.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.get_write_buffer_size">
WriteTransport.get_write_buffer_size()<a class="headerlink" href="#asyncio.WriteTransport.get_write_buffer_size" title="Permalink to this definition">¶</a></dt>
<dd>Return the current size of the output buffer used by the transport.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.get_write_buffer_limits">
WriteTransport.get_write_buffer_limits()<a class="headerlink" href="#asyncio.WriteTransport.get_write_buffer_limits" title="Permalink to this definition">¶</a></dt>
<dd>Get the high and low watermarks for write flow control. Return a
tuple <code class="docutils literal notranslate">(low, high)</code> where low and high are positive number of
bytes.
Use <a class="reference internal" href="#asyncio.WriteTransport.set_write_buffer_limits" title="asyncio.WriteTransport.set_write_buffer_limits"><code class="xref py py-meth docutils literal notranslate">set_write_buffer_limits()</code></a> to set the limits.
<div class="versionadded">
New in version 3.4.2.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.set_write_buffer_limits">
WriteTransport.set_write_buffer_limits(high=None, low=None)<a class="headerlink" href="#asyncio.WriteTransport.set_write_buffer_limits" title="Permalink to this definition">¶</a></dt>
<dd>Set the high and low watermarks for write flow control.
These two values (measured in number of
bytes) control when the protocol’s
<a class="reference internal" href="#asyncio.BaseProtocol.pause_writing" title="asyncio.BaseProtocol.pause_writing"><code class="xref py py-meth docutils literal notranslate">protocol.pause_writing()</code></a>
and <a class="reference internal" href="#asyncio.BaseProtocol.resume_writing" title="asyncio.BaseProtocol.resume_writing"><code class="xref py py-meth docutils literal notranslate">protocol.resume_writing()</code></a>
methods are called. If specified, the low watermark must be less
than or equal to the high watermark. Neither high nor low
can be negative.
<a class="reference internal" href="#asyncio.BaseProtocol.pause_writing" title="asyncio.BaseProtocol.pause_writing"><code class="xref py py-meth docutils literal notranslate">pause_writing()</code></a> is called when the buffer size
becomes greater than or equal to the high value. If writing has
been paused, <a class="reference internal" href="#asyncio.BaseProtocol.resume_writing" title="asyncio.BaseProtocol.resume_writing"><code class="xref py py-meth docutils literal notranslate">resume_writing()</code></a> is called when
the buffer size becomes less than or equal to the low value.
The defaults are implementation-specific. If only the
high watermark is given, the low watermark defaults to an
implementation-specific value less than or equal to the
high watermark. Setting high to zero forces low to zero as
well, and causes <a class="reference internal" href="#asyncio.BaseProtocol.pause_writing" title="asyncio.BaseProtocol.pause_writing"><code class="xref py py-meth docutils literal notranslate">pause_writing()</code></a> to be called
whenever the buffer becomes non-empty. Setting low to zero causes
<a class="reference internal" href="#asyncio.BaseProtocol.resume_writing" title="asyncio.BaseProtocol.resume_writing"><code class="xref py py-meth docutils literal notranslate">resume_writing()</code></a> to be called only once the
buffer is empty. Use of zero for either limit is generally
sub-optimal as it reduces opportunities for doing I/O and
computation concurrently.
Use <a class="reference internal" href="#asyncio.WriteTransport.get_write_buffer_limits" title="asyncio.WriteTransport.get_write_buffer_limits"><code class="xref py py-meth docutils literal notranslate">get_write_buffer_limits()</code></a>
to get the limits.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.write">
WriteTransport.write(data)<a class="headerlink" href="#asyncio.WriteTransport.write" title="Permalink to this definition">¶</a></dt>
<dd>Write some data bytes to the transport.
This method does not block; it buffers the data and arranges for it
to be sent out asynchronously.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.writelines">
WriteTransport.writelines(list_of_data)<a class="headerlink" href="#asyncio.WriteTransport.writelines" title="Permalink to this definition">¶</a></dt>
<dd>Write a list (or any iterable) of data bytes to the transport.
This is functionally equivalent to calling <a class="reference internal" href="#asyncio.WriteTransport.write" title="asyncio.WriteTransport.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a> on each
element yielded by the iterable, but may be implemented more
efficiently.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.WriteTransport.write_eof">
WriteTransport.write_eof()<a class="headerlink" href="#asyncio.WriteTransport.write_eof" title="Permalink to this definition">¶</a></dt>
<dd>Close the write end of the transport after flushing all buffered data.
Data may still be received.
This method can raise <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a> if the transport
(e.g. SSL) doesn’t support half-closed connections.
</dd></dl>

</section>
<section id="datagram-transports">
<h3>Datagram Transports<a class="headerlink" href="#datagram-transports" title="Permalink to this headline">¶</a></h3>
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.DatagramTransport.sendto">
DatagramTransport.sendto(data, addr=None)<a class="headerlink" href="#asyncio.DatagramTransport.sendto" title="Permalink to this definition">¶</a></dt>
<dd>Send the data bytes to the remote peer given by addr (a
transport-dependent target address). If addr is <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>,
the data is sent to the target address given on transport
creation.
This method does not block; it buffers the data and arranges
for it to be sent out asynchronously.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.DatagramTransport.abort">
DatagramTransport.abort()<a class="headerlink" href="#asyncio.DatagramTransport.abort" title="Permalink to this definition">¶</a></dt>
<dd>Close the transport immediately, without waiting for pending
operations to complete. Buffered data will be lost.
No more data will be received. The protocol’s
<a class="reference internal" href="#asyncio.BaseProtocol.connection_lost" title="asyncio.BaseProtocol.connection_lost"><code class="xref py py-meth docutils literal notranslate">protocol.connection_lost()</code></a>
method will eventually be called with <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> as its argument.
</dd></dl>

</section>
<section id="subprocess-transports">
<h3>Subprocess Transports<a class="headerlink" href="#subprocess-transports" title="Permalink to this headline">¶</a></h3>
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.get_pid">
SubprocessTransport.get_pid()<a class="headerlink" href="#asyncio.SubprocessTransport.get_pid" title="Permalink to this definition">¶</a></dt>
<dd>Return the subprocess process id as an integer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.get_pipe_transport">
SubprocessTransport.get_pipe_transport(fd)<a class="headerlink" href="#asyncio.SubprocessTransport.get_pipe_transport" title="Permalink to this definition">¶</a></dt>
<dd>Return the transport for the communication pipe corresponding to the
integer file descriptor fd:
<ul class="simple">
<li><code class="docutils literal notranslate">0</code>: readable streaming transport of the standard input (stdin),
or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> if the subprocess was not created with <code class="docutils literal notranslate">stdin=PIPE</code></li>
<li><code class="docutils literal notranslate">1</code>: writable streaming transport of the standard output (stdout),
or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> if the subprocess was not created with <code class="docutils literal notranslate">stdout=PIPE</code></li>
<li><code class="docutils literal notranslate">2</code>: writable streaming transport of the standard error (stderr),
or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> if the subprocess was not created with <code class="docutils literal notranslate">stderr=PIPE</code></li>
<li>other fd: <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a></li>
</ul>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.get_returncode">
SubprocessTransport.get_returncode()<a class="headerlink" href="#asyncio.SubprocessTransport.get_returncode" title="Permalink to this definition">¶</a></dt>
<dd>Return the subprocess return code as an integer or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>
if it hasn’t returned, which is similar to the
<a class="reference internal" href="subprocess.html#subprocess.Popen.returncode" title="subprocess.Popen.returncode"><code class="xref py py-attr docutils literal notranslate">subprocess.Popen.returncode</code></a> attribute.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.kill">
SubprocessTransport.kill()<a class="headerlink" href="#asyncio.SubprocessTransport.kill" title="Permalink to this definition">¶</a></dt>
<dd>Kill the subprocess.
On POSIX systems, the function sends SIGKILL to the subprocess.
On Windows, this method is an alias for <a class="reference internal" href="#asyncio.SubprocessTransport.terminate" title="asyncio.SubprocessTransport.terminate"><code class="xref py py-meth docutils literal notranslate">terminate()</code></a>.
See also <a class="reference internal" href="subprocess.html#subprocess.Popen.kill" title="subprocess.Popen.kill"><code class="xref py py-meth docutils literal notranslate">subprocess.Popen.kill()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.send_signal">
SubprocessTransport.send_signal(signal)<a class="headerlink" href="#asyncio.SubprocessTransport.send_signal" title="Permalink to this definition">¶</a></dt>
<dd>Send the signal number to the subprocess, as in
<a class="reference internal" href="subprocess.html#subprocess.Popen.send_signal" title="subprocess.Popen.send_signal"><code class="xref py py-meth docutils literal notranslate">subprocess.Popen.send_signal()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.terminate">
SubprocessTransport.terminate()<a class="headerlink" href="#asyncio.SubprocessTransport.terminate" title="Permalink to this definition">¶</a></dt>
<dd>Stop the subprocess.
On POSIX systems, this method sends SIGTERM to the subprocess.
On Windows, the Windows API function TerminateProcess() is called to
stop the subprocess.
See also <a class="reference internal" href="subprocess.html#subprocess.Popen.terminate" title="subprocess.Popen.terminate"><code class="xref py py-meth docutils literal notranslate">subprocess.Popen.terminate()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessTransport.close">
SubprocessTransport.close()<a class="headerlink" href="#asyncio.SubprocessTransport.close" title="Permalink to this definition">¶</a></dt>
<dd>Kill the subprocess by calling the <a class="reference internal" href="#asyncio.SubprocessTransport.kill" title="asyncio.SubprocessTransport.kill"><code class="xref py py-meth docutils literal notranslate">kill()</code></a> method.
If the subprocess hasn’t returned yet, and close transports of
stdin, stdout, and stderr pipes.
</dd></dl>

</section>
</section>
<section id="protocols">
<h2>Protocols<a class="headerlink" href="#protocols" title="Permalink to this headline">¶</a></h2>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/asyncio/protocols.py">Lib/asyncio/protocols.py</a>
<hr class="docutils" />
asyncio provides a set of abstract base classes that should be used
to implement network protocols. Those classes are meant to be used
together with <a class="reference internal" href="#asyncio-transport">transports</a>.
Subclasses of abstract base protocol classes may implement some or
all methods. All these methods are callbacks: they are called by
transports on certain events, for example when some data is received.
A base protocol method should be called by the corresponding transport.
<section id="base-protocols">
<h3>Base Protocols<a class="headerlink" href="#base-protocols" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="asyncio.BaseProtocol">
class asyncio.BaseProtocol<a class="headerlink" href="#asyncio.BaseProtocol" title="Permalink to this definition">¶</a></dt>
<dd>Base protocol with methods that all protocols share.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.Protocol">
class asyncio.Protocol(BaseProtocol)<a class="headerlink" href="#asyncio.Protocol" title="Permalink to this definition">¶</a></dt>
<dd>The base class for implementing streaming protocols
(TCP, Unix sockets, etc).
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.BufferedProtocol">
class asyncio.BufferedProtocol(BaseProtocol)<a class="headerlink" href="#asyncio.BufferedProtocol" title="Permalink to this definition">¶</a></dt>
<dd>A base class for implementing streaming protocols with manual
control of the receive buffer.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.DatagramProtocol">
class asyncio.DatagramProtocol(BaseProtocol)<a class="headerlink" href="#asyncio.DatagramProtocol" title="Permalink to this definition">¶</a></dt>
<dd>The base class for implementing datagram (UDP) protocols.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="asyncio.SubprocessProtocol">
class asyncio.SubprocessProtocol(BaseProtocol)<a class="headerlink" href="#asyncio.SubprocessProtocol" title="Permalink to this definition">¶</a></dt>
<dd>The base class for implementing protocols communicating with child
processes (unidirectional pipes).
</dd></dl>

</section>
<section id="base-protocol">
<h3>Base Protocol<a class="headerlink" href="#base-protocol" title="Permalink to this headline">¶</a></h3>
All asyncio protocols can implement Base Protocol callbacks.
Connection Callbacks
Connection callbacks are called on all protocols, exactly once per
a successful connection. All other protocol callbacks can only be
called between those two methods.
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseProtocol.connection_made">
BaseProtocol.connection_made(transport)<a class="headerlink" href="#asyncio.BaseProtocol.connection_made" title="Permalink to this definition">¶</a></dt>
<dd>Called when a connection is made.
The transport argument is the transport representing the
connection. The protocol is responsible for storing the reference
to its transport.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseProtocol.connection_lost">
BaseProtocol.connection_lost(exc)<a class="headerlink" href="#asyncio.BaseProtocol.connection_lost" title="Permalink to this definition">¶</a></dt>
<dd>Called when the connection is lost or closed.
The argument is either an exception object or <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>.
The latter means a regular EOF is received, or the connection was
aborted or closed by this side of the connection.
</dd></dl>

Flow Control Callbacks
Flow control callbacks can be called by transports to pause or
resume writing performed by the protocol.
See the documentation of the <a class="reference internal" href="#asyncio.WriteTransport.set_write_buffer_limits" title="asyncio.WriteTransport.set_write_buffer_limits"><code class="xref py py-meth docutils literal notranslate">set_write_buffer_limits()</code></a>
method for more details.
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseProtocol.pause_writing">
BaseProtocol.pause_writing()<a class="headerlink" href="#asyncio.BaseProtocol.pause_writing" title="Permalink to this definition">¶</a></dt>
<dd>Called when the transport’s buffer goes over the high watermark.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BaseProtocol.resume_writing">
BaseProtocol.resume_writing()<a class="headerlink" href="#asyncio.BaseProtocol.resume_writing" title="Permalink to this definition">¶</a></dt>
<dd>Called when the transport’s buffer drains below the low watermark.
</dd></dl>

If the buffer size equals the high watermark,
<a class="reference internal" href="#asyncio.BaseProtocol.pause_writing" title="asyncio.BaseProtocol.pause_writing"><code class="xref py py-meth docutils literal notranslate">pause_writing()</code></a> is not called: the buffer size must
go strictly over.
Conversely, <a class="reference internal" href="#asyncio.BaseProtocol.resume_writing" title="asyncio.BaseProtocol.resume_writing"><code class="xref py py-meth docutils literal notranslate">resume_writing()</code></a> is called when the
buffer size is equal or lower than the low watermark. These end
conditions are important to ensure that things go as expected when
either mark is zero.
</section>
<section id="streaming-protocols">
<h3>Streaming Protocols<a class="headerlink" href="#streaming-protocols" title="Permalink to this headline">¶</a></h3>
Event methods, such as <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_server" title="asyncio.loop.create_server"><code class="xref py py-meth docutils literal notranslate">loop.create_server()</code></a>,
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_unix_server" title="asyncio.loop.create_unix_server"><code class="xref py py-meth docutils literal notranslate">loop.create_unix_server()</code></a>, <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_connection" title="asyncio.loop.create_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_connection()</code></a>,
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_unix_connection" title="asyncio.loop.create_unix_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_unix_connection()</code></a>, <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.connect_accepted_socket" title="asyncio.loop.connect_accepted_socket"><code class="xref py py-meth docutils literal notranslate">loop.connect_accepted_socket()</code></a>,
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.connect_read_pipe" title="asyncio.loop.connect_read_pipe"><code class="xref py py-meth docutils literal notranslate">loop.connect_read_pipe()</code></a>, and <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.connect_write_pipe" title="asyncio.loop.connect_write_pipe"><code class="xref py py-meth docutils literal notranslate">loop.connect_write_pipe()</code></a>
accept factories that return streaming protocols.
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.Protocol.data_received">
Protocol.data_received(data)<a class="headerlink" href="#asyncio.Protocol.data_received" title="Permalink to this definition">¶</a></dt>
<dd>Called when some data is received. data is a non-empty bytes
object containing the incoming data.
Whether the data is buffered, chunked or reassembled depends on
the transport. In general, you shouldn’t rely on specific semantics
and instead make your parsing generic and flexible. However,
data is always received in the correct order.
The method can be called an arbitrary number of times while
a connection is open.
However, <a class="reference internal" href="#asyncio.Protocol.eof_received" title="asyncio.Protocol.eof_received"><code class="xref py py-meth docutils literal notranslate">protocol.eof_received()</code></a>
is called at most once. Once <code class="docutils literal notranslate">eof_received()</code> is called,
<code class="docutils literal notranslate">data_received()</code> is not called anymore.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.Protocol.eof_received">
Protocol.eof_received()<a class="headerlink" href="#asyncio.Protocol.eof_received" title="Permalink to this definition">¶</a></dt>
<dd>Called when the other end signals it won’t send any more data
(for example by calling <a class="reference internal" href="#asyncio.WriteTransport.write_eof" title="asyncio.WriteTransport.write_eof"><code class="xref py py-meth docutils literal notranslate">transport.write_eof()</code></a>, if the other end also uses
asyncio).
This method may return a false value (including <code class="docutils literal notranslate">None</code>), in which case
the transport will close itself. Conversely, if this method returns a
true value, the protocol used determines whether to close the transport.
Since the default implementation returns <code class="docutils literal notranslate">None</code>, it implicitly closes the
connection.
Some transports, including SSL, don’t support half-closed connections,
in which case returning true from this method will result in the connection
being closed.
</dd></dl>

State machine:
<div class="highlight-none notranslate"><div class="highlight"><pre>start -&gt; connection_made
 [-&gt; data_received]*
 [-&gt; eof_received]?
-&gt; connection_lost -&gt; end
</pre></div>
</div>
</section>
<section id="buffered-streaming-protocols">
<h3>Buffered Streaming Protocols<a class="headerlink" href="#buffered-streaming-protocols" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
New in version 3.7.
</div>
Buffered Protocols can be used with any event loop method
that supports <a class="reference internal" href="#streaming-protocols">Streaming Protocols</a>.
<code class="docutils literal notranslate">BufferedProtocol</code> implementations allow explicit manual allocation
and control of the receive buffer. Event loops can then use the buffer
provided by the protocol to avoid unnecessary data copies. This
can result in noticeable performance improvement for protocols that
receive big amounts of data. Sophisticated protocol implementations
can significantly reduce the number of buffer allocations.
The following callbacks are called on <a class="reference internal" href="#asyncio.BufferedProtocol" title="asyncio.BufferedProtocol"><code class="xref py py-class docutils literal notranslate">BufferedProtocol</code></a>
instances:
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BufferedProtocol.get_buffer">
BufferedProtocol.get_buffer(sizehint)<a class="headerlink" href="#asyncio.BufferedProtocol.get_buffer" title="Permalink to this definition">¶</a></dt>
<dd>Called to allocate a new receive buffer.
sizehint is the recommended minimum size for the returned
buffer. It is acceptable to return smaller or larger buffers
than what sizehint suggests. When set to -1, the buffer size
can be arbitrary. It is an error to return a buffer with a zero size.
<code class="docutils literal notranslate">get_buffer()</code> must return an object implementing the
<a class="reference internal" href="../c-api/buffer.html#bufferobjects">buffer protocol</a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BufferedProtocol.buffer_updated">
BufferedProtocol.buffer_updated(nbytes)<a class="headerlink" href="#asyncio.BufferedProtocol.buffer_updated" title="Permalink to this definition">¶</a></dt>
<dd>Called when the buffer was updated with the received data.
nbytes is the total number of bytes that were written to the buffer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.BufferedProtocol.eof_received">
BufferedProtocol.eof_received()<a class="headerlink" href="#asyncio.BufferedProtocol.eof_received" title="Permalink to this definition">¶</a></dt>
<dd>See the documentation of the <a class="reference internal" href="#asyncio.Protocol.eof_received" title="asyncio.Protocol.eof_received"><code class="xref py py-meth docutils literal notranslate">protocol.eof_received()</code></a> method.
</dd></dl>

<a class="reference internal" href="#asyncio.BufferedProtocol.get_buffer" title="asyncio.BufferedProtocol.get_buffer"><code class="xref py py-meth docutils literal notranslate">get_buffer()</code></a> can be called an arbitrary number
of times during a connection. However, <a class="reference internal" href="#asyncio.Protocol.eof_received" title="asyncio.Protocol.eof_received"><code class="xref py py-meth docutils literal notranslate">protocol.eof_received()</code></a> is called at most once
and, if called, <a class="reference internal" href="#asyncio.BufferedProtocol.get_buffer" title="asyncio.BufferedProtocol.get_buffer"><code class="xref py py-meth docutils literal notranslate">get_buffer()</code></a> and
<a class="reference internal" href="#asyncio.BufferedProtocol.buffer_updated" title="asyncio.BufferedProtocol.buffer_updated"><code class="xref py py-meth docutils literal notranslate">buffer_updated()</code></a> won’t be called after it.
State machine:
<div class="highlight-none notranslate"><div class="highlight"><pre>start -&gt; connection_made
 [-&gt; get_buffer
 [-&gt; buffer_updated]?
 ]*
 [-&gt; eof_received]?
-&gt; connection_lost -&gt; end
</pre></div>
</div>
</section>
<section id="datagram-protocols">
<h3>Datagram Protocols<a class="headerlink" href="#datagram-protocols" title="Permalink to this headline">¶</a></h3>
Datagram Protocol instances should be constructed by protocol
factories passed to the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="asyncio.loop.create_datagram_endpoint"><code class="xref py py-meth docutils literal notranslate">loop.create_datagram_endpoint()</code></a> method.
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.DatagramProtocol.datagram_received">
DatagramProtocol.datagram_received(data, addr)<a class="headerlink" href="#asyncio.DatagramProtocol.datagram_received" title="Permalink to this definition">¶</a></dt>
<dd>Called when a datagram is received. data is a bytes object containing
the incoming data. addr is the address of the peer sending the data;
the exact format depends on the transport.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.DatagramProtocol.error_received">
DatagramProtocol.error_received(exc)<a class="headerlink" href="#asyncio.DatagramProtocol.error_received" title="Permalink to this definition">¶</a></dt>
<dd>Called when a previous send or receive operation raises an
<a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-class docutils literal notranslate">OSError</code></a>. exc is the <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-class docutils literal notranslate">OSError</code></a> instance.
This method is called in rare conditions, when the transport (e.g. UDP)
detects that a datagram could not be delivered to its recipient.
In many conditions though, undeliverable datagrams will be silently
dropped.
</dd></dl>

<div class="admonition note">
Note
On BSD systems (macOS, FreeBSD, etc.) flow control is not supported
for datagram protocols, because there is no reliable way to detect send
failures caused by writing too many packets.
The socket always appears ‘ready’ and excess packets are dropped. An
<a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-class docutils literal notranslate">OSError</code></a> with <code class="docutils literal notranslate">errno</code> set to <a class="reference internal" href="errno.html#errno.ENOBUFS" title="errno.ENOBUFS"><code class="xref py py-const docutils literal notranslate">errno.ENOBUFS</code></a> may
or may not be raised; if it is raised, it will be reported to
<a class="reference internal" href="#asyncio.DatagramProtocol.error_received" title="asyncio.DatagramProtocol.error_received"><code class="xref py py-meth docutils literal notranslate">DatagramProtocol.error_received()</code></a> but otherwise ignored.
</div>
</section>
<section id="subprocess-protocols">
<h3>Subprocess Protocols<a class="headerlink" href="#subprocess-protocols" title="Permalink to this headline">¶</a></h3>
Subprocess Protocol instances should be constructed by protocol
factories passed to the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_exec" title="asyncio.loop.subprocess_exec"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_exec()</code></a> and
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_shell" title="asyncio.loop.subprocess_shell"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_shell()</code></a> methods.
<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessProtocol.pipe_data_received">
SubprocessProtocol.pipe_data_received(fd, data)<a class="headerlink" href="#asyncio.SubprocessProtocol.pipe_data_received" title="Permalink to this definition">¶</a></dt>
<dd>Called when the child process writes data into its stdout or stderr
pipe.
fd is the integer file descriptor of the pipe.
data is a non-empty bytes object containing the received data.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessProtocol.pipe_connection_lost">
SubprocessProtocol.pipe_connection_lost(fd, exc)<a class="headerlink" href="#asyncio.SubprocessProtocol.pipe_connection_lost" title="Permalink to this definition">¶</a></dt>
<dd>Called when one of the pipes communicating with the child process
is closed.
fd is the integer file descriptor that was closed.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="asyncio.SubprocessProtocol.process_exited">
SubprocessProtocol.process_exited()<a class="headerlink" href="#asyncio.SubprocessProtocol.process_exited" title="Permalink to this definition">¶</a></dt>
<dd>Called when the child process has exited.
</dd></dl>

</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<section id="tcp-echo-server">
<h3>TCP Echo Server<a class="headerlink" href="#tcp-echo-server" title="Permalink to this headline">¶</a></h3>
Create a TCP echo server using the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_server" title="asyncio.loop.create_server"><code class="xref py py-meth docutils literal notranslate">loop.create_server()</code></a> method, send back
received data, and close the connection:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import asyncio

class EchoServerProtocol(asyncio.Protocol):
 def connection_made(self, transport):
 peername = transport.get_extra_info(&#39;peername&#39;)
 print(&#39;Connection from {}&#39;.format(peername))
 self.transport = transport

def data_received(self, data):
 message = data.decode()
 print(&#39;Data received: {!r}&#39;.format(message))

print(&#39;Send: {!r}&#39;.format(message))
 self.transport.write(data)

print(&#39;Close the client socket&#39;)
 self.transport.close()

async def main():
 # Get a reference to the event loop as we plan to use
 # low-level APIs.
 loop = asyncio.get_running_loop()

server = await loop.create_server(
 lambda: EchoServerProtocol(),
 &#39;127.0.0.1&#39;, 8888)

async with server:
 await server.serve_forever()

class EchoClientProtocol(asyncio.Protocol):
 def __init__(self, message, on_con_lost):
 self.message = message
 self.on_con_lost = on_con_lost

def connection_made(self, transport):
 transport.write(self.message.encode())
 print(&#39;Data sent: {!r}&#39;.format(self.message))

def data_received(self, data):
 print(&#39;Data received: {!r}&#39;.format(data.decode()))

def connection_lost(self, exc):
 print(&#39;The server closed the connection&#39;)
 self.on_con_lost.set_result(True)

on_con_lost = loop.create_future()
 message = &#39;Hello World!&#39;

transport, protocol = await loop.create_connection(
 lambda: EchoClientProtocol(message, on_con_lost),
 &#39;127.0.0.1&#39;, 8888)

# Wait until the protocol signals that the connection
 # is lost and close the transport.
 try:
 await on_con_lost
 finally:
 transport.close()

class EchoServerProtocol:
 def connection_made(self, transport):
 self.transport = transport

def datagram_received(self, data, addr):
 message = data.decode()
 print(&#39;Received %r from %s&#39; % (message, addr))
 print(&#39;Send %r to %s&#39; % (message, addr))
 self.transport.sendto(data, addr)

async def main():
 print(&quot;Starting UDP server&quot;)

# Get a reference to the event loop as we plan to use
 # low-level APIs.
 loop = asyncio.get_running_loop()

# One protocol instance will be created to serve all
 # client requests.
 transport, protocol = await loop.create_datagram_endpoint(
 lambda: EchoServerProtocol(),
 local_addr=(&#39;127.0.0.1&#39;, 9999))

try:
 await asyncio.sleep(3600) # Serve for 1 hour.
 finally:
 transport.close()

asyncio.run(main())
</pre></div>
</div>
</section>
<section id="udp-echo-client">
<h3>UDP Echo Client<a class="headerlink" href="#udp-echo-client" title="Permalink to this headline">¶</a></h3>
A UDP echo client, using the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="asyncio.loop.create_datagram_endpoint"><code class="xref py py-meth docutils literal notranslate">loop.create_datagram_endpoint()</code></a>
method, sends data and closes the transport when it receives the answer:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import asyncio

class EchoClientProtocol:
 def __init__(self, message, on_con_lost):
 self.message = message
 self.on_con_lost = on_con_lost
 self.transport = None

def connection_made(self, transport):
 self.transport = transport
 print(&#39;Send:&#39;, self.message)
 self.transport.sendto(self.message.encode())

print(&quot;Close the socket&quot;)
 self.transport.close()

def error_received(self, exc):
 print(&#39;Error received:&#39;, exc)

def connection_lost(self, exc):
 print(&quot;Connection closed&quot;)
 self.on_con_lost.set_result(True)

transport, protocol = await loop.create_datagram_endpoint(
 lambda: EchoClientProtocol(message, on_con_lost),
 remote_addr=(&#39;127.0.0.1&#39;, 9999))

try:
 await on_con_lost
 finally:
 transport.close()

asyncio.run(main())
</pre></div>
</div>
</section>
<section id="connecting-existing-sockets">
<h3>Connecting Existing Sockets<a class="headerlink" href="#connecting-existing-sockets" title="Permalink to this headline">¶</a></h3>
Wait until a socket receives data using the
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.create_connection" title="asyncio.loop.create_connection"><code class="xref py py-meth docutils literal notranslate">loop.create_connection()</code></a> method with a protocol:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import asyncio
import socket

class MyProtocol(asyncio.Protocol):

def __init__(self, on_con_lost):
 self.transport = None
 self.on_con_lost = on_con_lost

# We are done: close the transport;
 # connection_lost() will be called automatically.
 self.transport.close()

def connection_lost(self, exc):
 # The socket has been closed
 self.on_con_lost.set_result(True)

# Create a pair of connected sockets
 rsock, wsock = socket.socketpair()

# Register the socket to wait for data.
 transport, protocol = await loop.create_connection(
 lambda: MyProtocol(on_con_lost), sock=rsock)

# Simulate the reception of data from the network.
 loop.call_soon(wsock.send, &#39;abc&#39;.encode())

try:
 await protocol.on_con_lost
 finally:
 transport.close()
 wsock.close()

asyncio.run(main())
</pre></div>
</div>
<div class="admonition seealso">
See also
The <a class="reference internal" href="asyncio-eventloop.html#asyncio-example-watch-fd">watch a file descriptor for read events</a> example uses the low-level
<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.add_reader" title="asyncio.loop.add_reader"><code class="xref py py-meth docutils literal notranslate">loop.add_reader()</code></a> method to register an FD.
The <a class="reference internal" href="asyncio-stream.html#asyncio-example-create-connection-streams">register an open socket to wait for data using streams</a> example uses high-level streams
created by the <a class="reference internal" href="asyncio-stream.html#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate">open_connection()</code></a> function in a coroutine.
</div>
</section>
<section id="loop-subprocess-exec-and-subprocessprotocol">
<h3>loop.subprocess_exec() and SubprocessProtocol<a class="headerlink" href="#loop-subprocess-exec-and-subprocessprotocol" title="Permalink to this headline">¶</a></h3>
An example of a subprocess protocol used to get the output of a
subprocess and to wait for the subprocess exit.
The subprocess is created by the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.subprocess_exec" title="asyncio.loop.subprocess_exec"><code class="xref py py-meth docutils literal notranslate">loop.subprocess_exec()</code></a> method:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import asyncio
import sys

class DateProtocol(asyncio.SubprocessProtocol):
 def __init__(self, exit_future):
 self.exit_future = exit_future
 self.output = bytearray()

def pipe_data_received(self, fd, data):
 self.output.extend(data)

def process_exited(self):
 self.exit_future.set_result(True)

async def get_date():
 # Get a reference to the event loop as we plan to use
 # low-level APIs.
 loop = asyncio.get_running_loop()

code = &#39;import datetime; print(datetime.datetime.now())&#39;
 exit_future = asyncio.Future(loop=loop)

# Create the subprocess controlled by DateProtocol;
 # redirect the standard output into a pipe.
 transport, protocol = await loop.subprocess_exec(
 lambda: DateProtocol(exit_future),
 sys.executable, &#39;-c&#39;, code,
 stdin=None, stderr=None)

# Wait for the subprocess exit using the process_exited()
 # method of the protocol.
 await exit_future

# Close the stdout pipe.
 transport.close()

# Read the output which was collected by the
 # pipe_data_received() method of the protocol.
 data = bytes(protocol.output)
 return data.decode(&#39;ascii&#39;).rstrip()

date = asyncio.run(get_date())
print(f&quot;Current date: {date}&quot;)
</pre></div>
</div>
See also the <a class="reference internal" href="asyncio-subprocess.html#asyncio-example-create-subprocess-exec">same example</a>
written using high-level APIs.
</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="#">Transports and Protocols</a><ul>
<li><a class="reference internal" href="#transports">Transports</a><ul>
<li><a class="reference internal" href="#transports-hierarchy">Transports Hierarchy</a></li>
<li><a class="reference internal" href="#base-transport">Base Transport</a></li>
<li><a class="reference internal" href="#read-only-transports">Read-only Transports</a></li>
<li><a class="reference internal" href="#write-only-transports">Write-only Transports</a></li>
<li><a class="reference internal" href="#datagram-transports">Datagram Transports</a></li>
<li><a class="reference internal" href="#subprocess-transports">Subprocess Transports</a></li>
</ul>
</li>
<li><a class="reference internal" href="#protocols">Protocols</a><ul>
<li><a class="reference internal" href="#base-protocols">Base Protocols</a></li>
<li><a class="reference internal" href="#base-protocol">Base Protocol</a></li>
<li><a class="reference internal" href="#streaming-protocols">Streaming Protocols</a></li>
<li><a class="reference internal" href="#buffered-streaming-protocols">Buffered Streaming Protocols</a></li>
<li><a class="reference internal" href="#datagram-protocols">Datagram Protocols</a></li>
<li><a class="reference internal" href="#subprocess-protocols">Subprocess Protocols</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#tcp-echo-server">TCP Echo Server</a></li>
<li><a class="reference internal" href="#tcp-echo-client">TCP Echo Client</a></li>
<li><a class="reference internal" href="#udp-echo-server">UDP Echo Server</a></li>
<li><a class="reference internal" href="#udp-echo-client">UDP Echo Client</a></li>
<li><a class="reference internal" href="#connecting-existing-sockets">Connecting Existing Sockets</a></li>
<li><a class="reference internal" href="#loop-subprocess-exec-and-subprocessprotocol">loop.subprocess_exec() and SubprocessProtocol</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="asyncio-future.html"
 title="previous chapter">Futures</a>
 <h4>Next topic</h4>
 <a href="asyncio-policy.html"
 title="next chapter">Policies</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/asyncio-protocol.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </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="asyncio-policy.html" title="Policies"
 >next</a> |</li>
 <li class="right" >
 <a href="asyncio-future.html" title="Futures"
 >previous</a> |</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="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>
 <li class="nav-item nav-item-3"><a href="asyncio.html" ><code class="xref py py-mod docutils literal notranslate">asyncio</code> — Asynchronous I/O</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Transports and Protocols</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : asyncio-protocol.html