Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Tarkkaile 1
Äänestä 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Puu: 0f75e31513
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/asyncio-stream.html

888 lines
77KB
Raaka Blame Historia 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="Streams" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/asyncio-stream.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/asyncio/streams.py Streams are high-level async/await-ready primitives to work with network connections. Streams allow sending and receiving data without using callbacks or low-lev..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/asyncio/streams.py Streams are high-level async/await-ready primitives to work with network connections. Streams allow sending and receiving data without using callbacks or low-lev..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>Streams &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="Synchronization Primitives" href="asyncio-sync.html" />

  39.     <link rel="prev" title="Coroutines and Tasks" href="asyncio-task.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/asyncio-stream.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" 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"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#">Streams</a><ul>

  99. <li><a class="reference internal" href="#streamreader">StreamReader</a></li>

  100. <li><a class="reference internal" href="#streamwriter">StreamWriter</a></li>

  101. <li><a class="reference internal" href="#examples">Examples</a><ul>

  102. <li><a class="reference internal" href="#tcp-echo-client-using-streams">TCP echo client using streams</a></li>

  103. <li><a class="reference internal" href="#tcp-echo-server-using-streams">TCP echo server using streams</a></li>

  104. <li><a class="reference internal" href="#get-http-headers">Get HTTP headers</a></li>

  105. <li><a class="reference internal" href="#register-an-open-socket-to-wait-for-data-using-streams">Register an open socket to wait for data using streams</a></li>

  106. </ul>

  107. </li>

  108. </ul>

  109. </li>

  110. </ul>

  111. 

  112.   </div>

  113.   <div>

  114.     <h4>Previous topic</h4>

  115.     <p class="topless"><a href="asyncio-task.html"

  116.                           title="previous chapter">Coroutines and Tasks</a></p>

  117.   </div>

  118.   <div>

  119.     <h4>Next topic</h4>

  120.     <p class="topless"><a href="asyncio-sync.html"

  121.                           title="next chapter">Synchronization Primitives</a></p>

  122.   </div>

  123.   <div role="note" aria-label="source link">

  124.     <h3>This Page</h3>

  125.     <ul class="this-page-menu">

  126.       <li><a href="../bugs.html">Report a Bug</a></li>

  127.       <li>

  128.         <a href="https://github.com/python/cpython/blob/main/Doc/library/asyncio-stream.rst"

  129.             rel="nofollow">Show Source

  130.         </a>

  131.       </li>

  132.     </ul>

  133.   </div>

  134.         </nav>

  135.     </div>

  136. </div>

  137. 

  138.   

  139.     <div class="related" role="navigation" aria-label="related navigation">

  140.       <h3>Navigation</h3>

  141.       <ul>

  142.         <li class="right" style="margin-right: 10px">

  143.           <a href="../genindex.html" title="General Index"

  144.              accesskey="I">index</a></li>

  145.         <li class="right" >

  146.           <a href="../py-modindex.html" title="Python Module Index"

  147.              >modules</a> |</li>

  148.         <li class="right" >

  149.           <a href="asyncio-sync.html" title="Synchronization Primitives"

  150.              accesskey="N">next</a> |</li>

  151.         <li class="right" >

  152.           <a href="asyncio-task.html" title="Coroutines and Tasks"

  153.              accesskey="P">previous</a> |</li>

  154. 

  155.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  156.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  157.           <li class="switchers">

  158.             <div class="language_switcher_placeholder"></div>

  159.             <div class="version_switcher_placeholder"></div>

  160.           </li>

  161.           <li>

  162.               

  163.           </li>

  164.     <li id="cpython-language-and-version">

  165.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  166.     </li>

  167. 

  168.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  169.           <li class="nav-item nav-item-2"><a href="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>

  170.           <li class="nav-item nav-item-3"><a href="asyncio.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">asyncio</span></code> — Asynchronous I/O</a> &#187;</li>

  171.         <li class="nav-item nav-item-this"><a href="">Streams</a></li>

  172.                 <li class="right">

  173.                     

  174. 

  175.     <div class="inline-search" role="search">

  176.         <form class="inline-search" action="../search.html" method="get">

  177.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  178.           <input type="submit" value="Go" />

  179.         </form>

  180.     </div>

  181.                      |

  182.                 </li>

  183.             <li class="right">

  184. <label class="theme-selector-label">

  185.     Theme

  186.     <select class="theme-selector" oninput="activateTheme(this.value)">

  187.         <option value="auto" selected>Auto</option>

  188.         <option value="light">Light</option>

  189.         <option value="dark">Dark</option>

  190.     </select>

  191. </label> |</li>

  192.             

  193.       </ul>

  194.     </div>    

  195. 

  196.     <div class="document">

  197.       <div class="documentwrapper">

  198.         <div class="bodywrapper">

  199.           <div class="body" role="main">

  200.             

  201.   <section id="streams">

  202. <span id="asyncio-streams"></span><h1>Streams<a class="headerlink" href="#streams" title="Link to this heading">¶</a></h1>

  203. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/asyncio/streams.py">Lib/asyncio/streams.py</a></p>

  204. <hr class="docutils" />

  205. <p>Streams are high-level async/await-ready primitives to work with

  206. network connections.  Streams allow sending and receiving data without

  207. using callbacks or low-level protocols and transports.</p>

  208. <p id="asyncio-example-stream">Here is an example of a TCP echo client written using asyncio

  209. streams:</p>

  210. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">asyncio</span>

  211. 

  212. <span class="k">async</span> <span class="k">def</span> <span class="nf">tcp_echo_client</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>

  213.     <span class="n">reader</span><span class="p">,</span> <span class="n">writer</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">open_connection</span><span class="p">(</span>

  214.         <span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span> <span class="mi">8888</span><span class="p">)</span>

  215. 

  216.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Send: </span><span class="si">{</span><span class="n">message</span><span class="si">!r}</span><span class="s1">&#39;</span><span class="p">)</span>

  217.     <span class="n">writer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>

  218.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">drain</span><span class="p">()</span>

  219. 

  220.     <span class="n">data</span> <span class="o">=</span> <span class="k">await</span> <span class="n">reader</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>

  221.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Received: </span><span class="si">{</span><span class="n">data</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span><span class="si">!r}</span><span class="s1">&#39;</span><span class="p">)</span>

  222. 

  223.     <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Close the connection&#39;</span><span class="p">)</span>

  224.     <span class="n">writer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  225.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">wait_closed</span><span class="p">()</span>

  226. 

  227. <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">tcp_echo_client</span><span class="p">(</span><span class="s1">&#39;Hello World!&#39;</span><span class="p">))</span>

  228. </pre></div>

  229. </div>

  230. <p>See also the <a class="reference internal" href="#examples">Examples</a> section below.</p>

  231. <p class="rubric">Stream Functions</p>

  232. <p>The following top-level asyncio functions can be used to create

  233. and work with streams:</p>

  234. <dl class="py function">

  235. <dt class="sig sig-object py" id="asyncio.open_connection">

  236. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-prename descclassname"><span class="pre">asyncio.</span></span><span class="sig-name descname"><span class="pre">open_connection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proto</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_addr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_handshake_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_shutdown_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">happy_eyeballs_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interleave</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.open_connection" title="Link to this definition">¶</a></dt>

  237. <dd><p>Establish a network connection and return a pair of

  238. <code class="docutils literal notranslate"><span class="pre">(reader,</span> <span class="pre">writer)</span></code> objects.</p>

  239. <p>The returned <em>reader</em> and <em>writer</em> objects are instances of

  240. <a class="reference internal" href="#asyncio.StreamReader" title="asyncio.StreamReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamReader</span></code></a> and <a class="reference internal" href="#asyncio.StreamWriter" title="asyncio.StreamWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamWriter</span></code></a> classes.</p>

  241. <p><em>limit</em> determines the buffer size limit used by the

  242. returned <a class="reference internal" href="#asyncio.StreamReader" title="asyncio.StreamReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamReader</span></code></a> instance.  By default the <em>limit</em>

  243. is set to 64 KiB.</p>

  244. <p>The rest of the arguments are passed directly to

  245. <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"><span class="pre">loop.create_connection()</span></code></a>.</p>

  246. <div class="admonition note">

  247. <p class="admonition-title">Note</p>

  248. <p>The <em>sock</em> argument transfers ownership of the socket to the

  249. <a class="reference internal" href="#asyncio.StreamWriter" title="asyncio.StreamWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamWriter</span></code></a> created. To close the socket, call its

  250. <a class="reference internal" href="#asyncio.StreamWriter.close" title="asyncio.StreamWriter.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> method.</p>

  251. </div>

  252. <div class="versionchanged">

  253. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <em>ssl_handshake_timeout</em> parameter.</p>

  254. </div>

  255. <div class="versionchanged">

  256. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added the <em>happy_eyeballs_delay</em> and <em>interleave</em> parameters.</p>

  257. </div>

  258. <div class="versionchanged">

  259. <p><span class="versionmodified changed">Changed in version 3.10: </span>Removed the <em>loop</em> parameter.</p>

  260. </div>

  261. <div class="versionchanged">

  262. <p><span class="versionmodified changed">Changed in version 3.11: </span>Added the <em>ssl_shutdown_timeout</em> parameter.</p>

  263. </div>

  264. </dd></dl>

  265. 

  266. <dl class="py function">

  267. <dt class="sig sig-object py" id="asyncio.start_server">

  268. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-prename descclassname"><span class="pre">asyncio.</span></span><span class="sig-name descname"><span class="pre">start_server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_connected_cb</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">socket.AF_UNSPEC</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">socket.AI_PASSIVE</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backlog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reuse_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reuse_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_handshake_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_shutdown_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_serving</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.start_server" title="Link to this definition">¶</a></dt>

  269. <dd><p>Start a socket server.</p>

  270. <p>The <em>client_connected_cb</em> callback is called whenever a new client

  271. connection is established.  It receives a <code class="docutils literal notranslate"><span class="pre">(reader,</span> <span class="pre">writer)</span></code> pair

  272. as two arguments, instances of the <a class="reference internal" href="#asyncio.StreamReader" title="asyncio.StreamReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamReader</span></code></a> and

  273. <a class="reference internal" href="#asyncio.StreamWriter" title="asyncio.StreamWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamWriter</span></code></a> classes.</p>

  274. <p><em>client_connected_cb</em> can be a plain callable or a

  275. <a class="reference internal" href="asyncio-task.html#coroutine"><span class="std std-ref">coroutine function</span></a>; if it is a coroutine function,

  276. it will be automatically scheduled as a <a class="reference internal" href="asyncio-task.html#asyncio.Task" title="asyncio.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a>.</p>

  277. <p><em>limit</em> determines the buffer size limit used by the

  278. returned <a class="reference internal" href="#asyncio.StreamReader" title="asyncio.StreamReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamReader</span></code></a> instance.  By default the <em>limit</em>

  279. is set to 64 KiB.</p>

  280. <p>The rest of the arguments are passed directly to

  281. <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"><span class="pre">loop.create_server()</span></code></a>.</p>

  282. <div class="admonition note">

  283. <p class="admonition-title">Note</p>

  284. <p>The <em>sock</em> argument transfers ownership of the socket to the

  285. server created. To close the socket, call the server’s

  286. <a class="reference internal" href="asyncio-eventloop.html#asyncio.Server.close" title="asyncio.Server.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> method.</p>

  287. </div>

  288. <div class="versionchanged">

  289. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <em>ssl_handshake_timeout</em> and <em>start_serving</em> parameters.</p>

  290. </div>

  291. <div class="versionchanged">

  292. <p><span class="versionmodified changed">Changed in version 3.10: </span>Removed the <em>loop</em> parameter.</p>

  293. </div>

  294. <div class="versionchanged">

  295. <p><span class="versionmodified changed">Changed in version 3.11: </span>Added the <em>ssl_shutdown_timeout</em> parameter.</p>

  296. </div>

  297. </dd></dl>

  298. 

  299. <p class="rubric">Unix Sockets</p>

  300. <dl class="py function">

  301. <dt class="sig sig-object py" id="asyncio.open_unix_connection">

  302. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-prename descclassname"><span class="pre">asyncio.</span></span><span class="sig-name descname"><span class="pre">open_unix_connection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_handshake_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_shutdown_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.open_unix_connection" title="Link to this definition">¶</a></dt>

  303. <dd><blockquote>

  304. <div><p>Establish a Unix socket connection and return a pair of

  305. <code class="docutils literal notranslate"><span class="pre">(reader,</span> <span class="pre">writer)</span></code>.</p>

  306. <p>Similar to <a class="reference internal" href="#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">open_connection()</span></code></a> but operates on Unix sockets.</p>

  307. <p>See also the documentation of <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"><span class="pre">loop.create_unix_connection()</span></code></a>.</p>

  308. <div class="admonition note">

  309. <p class="admonition-title">Note</p>

  310. <p>The <em>sock</em> argument transfers ownership of the socket to the

  311. <a class="reference internal" href="#asyncio.StreamWriter" title="asyncio.StreamWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamWriter</span></code></a> created. To close the socket, call its

  312. <a class="reference internal" href="#asyncio.StreamWriter.close" title="asyncio.StreamWriter.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> method.</p>

  313. </div>

  314. <div class="availability docutils container">

  315. <p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: Unix.</p>

  316. </div>

  317. <div class="versionchanged">

  318. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <em>ssl_handshake_timeout</em> parameter.

  319. The <em>path</em> parameter can now be a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a></p>

  320. </div>

  321. <div class="versionchanged">

  322. <p><span class="versionmodified changed">Changed in version 3.10: </span>Removed the <em>loop</em> parameter.</p>

  323. </div>

  324. </div></blockquote>

  325. <div class="versionchanged">

  326. <p><span class="versionmodified changed">Changed in version 3.11: </span>Added the <em>ssl_shutdown_timeout</em> parameter.</p>

  327. </div>

  328. </dd></dl>

  329. 

  330. <dl class="py function">

  331. <dt class="sig sig-object py" id="asyncio.start_unix_server">

  332. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-prename descclassname"><span class="pre">asyncio.</span></span><span class="sig-name descname"><span class="pre">start_unix_server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_connected_cb</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sock</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backlog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_handshake_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_shutdown_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_serving</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.start_unix_server" title="Link to this definition">¶</a></dt>

  333. <dd><p>Start a Unix socket server.</p>

  334. <p>Similar to <a class="reference internal" href="#asyncio.start_server" title="asyncio.start_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">start_server()</span></code></a> but works with Unix sockets.</p>

  335. <p>See also the documentation of <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"><span class="pre">loop.create_unix_server()</span></code></a>.</p>

  336. <div class="admonition note">

  337. <p class="admonition-title">Note</p>

  338. <p>The <em>sock</em> argument transfers ownership of the socket to the

  339. server created. To close the socket, call the server’s

  340. <a class="reference internal" href="asyncio-eventloop.html#asyncio.Server.close" title="asyncio.Server.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> method.</p>

  341. </div>

  342. <div class="availability docutils container">

  343. <p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: Unix.</p>

  344. </div>

  345. <div class="versionchanged">

  346. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <em>ssl_handshake_timeout</em> and <em>start_serving</em> parameters.

  347. The <em>path</em> parameter can now be a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>.</p>

  348. </div>

  349. <div class="versionchanged">

  350. <p><span class="versionmodified changed">Changed in version 3.10: </span>Removed the <em>loop</em> parameter.</p>

  351. </div>

  352. <div class="versionchanged">

  353. <p><span class="versionmodified changed">Changed in version 3.11: </span>Added the <em>ssl_shutdown_timeout</em> parameter.</p>

  354. </div>

  355. </dd></dl>

  356. 

  357. <section id="streamreader">

  358. <h2>StreamReader<a class="headerlink" href="#streamreader" title="Link to this heading">¶</a></h2>

  359. <dl class="py class">

  360. <dt class="sig sig-object py" id="asyncio.StreamReader">

  361. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">asyncio.</span></span><span class="sig-name descname"><span class="pre">StreamReader</span></span><a class="headerlink" href="#asyncio.StreamReader" title="Link to this definition">¶</a></dt>

  362. <dd><p>Represents a reader object that provides APIs to read data

  363. from the IO stream. As an <a class="reference internal" href="../glossary.html#term-asynchronous-iterable"><span class="xref std std-term">asynchronous iterable</span></a>, the

  364. object supports the <a class="reference internal" href="../reference/compound_stmts.html#async-for"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">async</span> <span class="pre">for</span></code></a> statement.</p>

  365. <p>It is not recommended to instantiate <em>StreamReader</em> objects

  366. directly; use <a class="reference internal" href="#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">open_connection()</span></code></a> and <a class="reference internal" href="#asyncio.start_server" title="asyncio.start_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">start_server()</span></code></a>

  367. instead.</p>

  368. <dl class="py method">

  369. <dt class="sig sig-object py" id="asyncio.StreamReader.feed_eof">

  370. <span class="sig-name descname"><span class="pre">feed_eof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamReader.feed_eof" title="Link to this definition">¶</a></dt>

  371. <dd><p>Acknowledge the EOF.</p>

  372. </dd></dl>

  373. 

  374. <dl class="py method">

  375. <dt class="sig sig-object py" id="asyncio.StreamReader.read">

  376. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamReader.read" title="Link to this definition">¶</a></dt>

  377. <dd><p>Read up to <em>n</em> bytes from the stream.</p>

  378. <p>If <em>n</em> is not provided or set to <code class="docutils literal notranslate"><span class="pre">-1</span></code>,

  379. read until EOF, then return all read <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>.

  380. If EOF was received and the internal buffer is empty,

  381. return an empty <code class="docutils literal notranslate"><span class="pre">bytes</span></code> object.</p>

  382. <p>If <em>n</em> is <code class="docutils literal notranslate"><span class="pre">0</span></code>, return an empty <code class="docutils literal notranslate"><span class="pre">bytes</span></code> object immediately.</p>

  383. <p>If <em>n</em> is positive, return at most <em>n</em> available <code class="docutils literal notranslate"><span class="pre">bytes</span></code>

  384. as soon as at least 1 byte is available in the internal buffer.

  385. If EOF is received before any byte is read, return an empty

  386. <code class="docutils literal notranslate"><span class="pre">bytes</span></code> object.</p>

  387. </dd></dl>

  388. 

  389. <dl class="py method">

  390. <dt class="sig sig-object py" id="asyncio.StreamReader.readline">

  391. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">readline</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamReader.readline" title="Link to this definition">¶</a></dt>

  392. <dd><p>Read one line, where “line” is a sequence of bytes

  393. ending with <code class="docutils literal notranslate"><span class="pre">\n</span></code>.</p>

  394. <p>If EOF is received and <code class="docutils literal notranslate"><span class="pre">\n</span></code> was not found, the method

  395. returns partially read data.</p>

  396. <p>If EOF is received and the internal buffer is empty,

  397. return an empty <code class="docutils literal notranslate"><span class="pre">bytes</span></code> object.</p>

  398. </dd></dl>

  399. 

  400. <dl class="py method">

  401. <dt class="sig sig-object py" id="asyncio.StreamReader.readexactly">

  402. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">readexactly</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamReader.readexactly" title="Link to this definition">¶</a></dt>

  403. <dd><p>Read exactly <em>n</em> bytes.</p>

  404. <p>Raise an <a class="reference internal" href="asyncio-exceptions.html#asyncio.IncompleteReadError" title="asyncio.IncompleteReadError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IncompleteReadError</span></code></a> if EOF is reached before <em>n</em>

  405. can be read.  Use the <a class="reference internal" href="asyncio-exceptions.html#asyncio.IncompleteReadError.partial" title="asyncio.IncompleteReadError.partial"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IncompleteReadError.partial</span></code></a>

  406. attribute to get the partially read data.</p>

  407. </dd></dl>

  408. 

  409. <dl class="py method">

  410. <dt class="sig sig-object py" id="asyncio.StreamReader.readuntil">

  411. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">readuntil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">b'\n'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamReader.readuntil" title="Link to this definition">¶</a></dt>

  412. <dd><p>Read data from the stream until <em>separator</em> is found.</p>

  413. <p>On success, the data and separator will be removed from the

  414. internal buffer (consumed). Returned data will include the

  415. separator at the end.</p>

  416. <p>If the amount of data read exceeds the configured stream limit, a

  417. <a class="reference internal" href="asyncio-exceptions.html#asyncio.LimitOverrunError" title="asyncio.LimitOverrunError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">LimitOverrunError</span></code></a> exception is raised, and the data

  418. is left in the internal buffer and can be read again.</p>

  419. <p>If EOF is reached before the complete separator is found,

  420. an <a class="reference internal" href="asyncio-exceptions.html#asyncio.IncompleteReadError" title="asyncio.IncompleteReadError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IncompleteReadError</span></code></a> exception is raised, and the internal

  421. buffer is reset.  The <a class="reference internal" href="asyncio-exceptions.html#asyncio.IncompleteReadError.partial" title="asyncio.IncompleteReadError.partial"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IncompleteReadError.partial</span></code></a> attribute

  422. may contain a portion of the separator.</p>

  423. <div class="versionadded">

  424. <p><span class="versionmodified added">New in version 3.5.2.</span></p>

  425. </div>

  426. </dd></dl>

  427. 

  428. <dl class="py method">

  429. <dt class="sig sig-object py" id="asyncio.StreamReader.at_eof">

  430. <span class="sig-name descname"><span class="pre">at_eof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamReader.at_eof" title="Link to this definition">¶</a></dt>

  431. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the buffer is empty and <a class="reference internal" href="#asyncio.StreamReader.feed_eof" title="asyncio.StreamReader.feed_eof"><code class="xref py py-meth docutils literal notranslate"><span class="pre">feed_eof()</span></code></a>

  432. was called.</p>

  433. </dd></dl>

  434. 

  435. </dd></dl>

  436. 

  437. </section>

  438. <section id="streamwriter">

  439. <h2>StreamWriter<a class="headerlink" href="#streamwriter" title="Link to this heading">¶</a></h2>

  440. <dl class="py class">

  441. <dt class="sig sig-object py" id="asyncio.StreamWriter">

  442. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">asyncio.</span></span><span class="sig-name descname"><span class="pre">StreamWriter</span></span><a class="headerlink" href="#asyncio.StreamWriter" title="Link to this definition">¶</a></dt>

  443. <dd><p>Represents a writer object that provides APIs to write data

  444. to the IO stream.</p>

  445. <p>It is not recommended to instantiate <em>StreamWriter</em> objects

  446. directly; use <a class="reference internal" href="#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">open_connection()</span></code></a> and <a class="reference internal" href="#asyncio.start_server" title="asyncio.start_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">start_server()</span></code></a>

  447. instead.</p>

  448. <dl class="py method">

  449. <dt class="sig sig-object py" id="asyncio.StreamWriter.write">

  450. <span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.write" title="Link to this definition">¶</a></dt>

  451. <dd><p>The method attempts to write the <em>data</em> to the underlying socket immediately.

  452. If that fails, the data is queued in an internal write buffer until it can be

  453. sent.</p>

  454. <p>The method should be used along with the <code class="docutils literal notranslate"><span class="pre">drain()</span></code> method:</p>

  455. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  456. <span class="k">await</span> <span class="n">stream</span><span class="o">.</span><span class="n">drain</span><span class="p">()</span>

  457. </pre></div>

  458. </div>

  459. </dd></dl>

  460. 

  461. <dl class="py method">

  462. <dt class="sig sig-object py" id="asyncio.StreamWriter.writelines">

  463. <span class="sig-name descname"><span class="pre">writelines</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.writelines" title="Link to this definition">¶</a></dt>

  464. <dd><p>The method writes a list (or any iterable) of bytes to the underlying socket

  465. immediately.

  466. If that fails, the data is queued in an internal write buffer until it can be

  467. sent.</p>

  468. <p>The method should be used along with the <code class="docutils literal notranslate"><span class="pre">drain()</span></code> method:</p>

  469. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">stream</span><span class="o">.</span><span class="n">writelines</span><span class="p">(</span><span class="n">lines</span><span class="p">)</span>

  470. <span class="k">await</span> <span class="n">stream</span><span class="o">.</span><span class="n">drain</span><span class="p">()</span>

  471. </pre></div>

  472. </div>

  473. </dd></dl>

  474. 

  475. <dl class="py method">

  476. <dt class="sig sig-object py" id="asyncio.StreamWriter.close">

  477. <span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.close" title="Link to this definition">¶</a></dt>

  478. <dd><p>The method closes the stream and the underlying socket.</p>

  479. <p>The method should be used, though not mandatory,

  480. along with the <code class="docutils literal notranslate"><span class="pre">wait_closed()</span></code> method:</p>

  481. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">stream</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  482. <span class="k">await</span> <span class="n">stream</span><span class="o">.</span><span class="n">wait_closed</span><span class="p">()</span>

  483. </pre></div>

  484. </div>

  485. </dd></dl>

  486. 

  487. <dl class="py method">

  488. <dt class="sig sig-object py" id="asyncio.StreamWriter.can_write_eof">

  489. <span class="sig-name descname"><span class="pre">can_write_eof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.can_write_eof" title="Link to this definition">¶</a></dt>

  490. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the underlying transport supports

  491. the <a class="reference internal" href="#asyncio.StreamWriter.write_eof" title="asyncio.StreamWriter.write_eof"><code class="xref py py-meth docutils literal notranslate"><span class="pre">write_eof()</span></code></a> method, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>

  492. </dd></dl>

  493. 

  494. <dl class="py method">

  495. <dt class="sig sig-object py" id="asyncio.StreamWriter.write_eof">

  496. <span class="sig-name descname"><span class="pre">write_eof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.write_eof" title="Link to this definition">¶</a></dt>

  497. <dd><p>Close the write end of the stream after the buffered write

  498. data is flushed.</p>

  499. </dd></dl>

  500. 

  501. <dl class="py attribute">

  502. <dt class="sig sig-object py" id="asyncio.StreamWriter.transport">

  503. <span class="sig-name descname"><span class="pre">transport</span></span><a class="headerlink" href="#asyncio.StreamWriter.transport" title="Link to this definition">¶</a></dt>

  504. <dd><p>Return the underlying asyncio transport.</p>

  505. </dd></dl>

  506. 

  507. <dl class="py method">

  508. <dt class="sig sig-object py" id="asyncio.StreamWriter.get_extra_info">

  509. <span class="sig-name descname"><span class="pre">get_extra_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.get_extra_info" title="Link to this definition">¶</a></dt>

  510. <dd><p>Access optional transport information; see

  511. <a class="reference internal" href="asyncio-protocol.html#asyncio.BaseTransport.get_extra_info" title="asyncio.BaseTransport.get_extra_info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">BaseTransport.get_extra_info()</span></code></a> for details.</p>

  512. </dd></dl>

  513. 

  514. <dl class="py method">

  515. <dt class="sig sig-object py" id="asyncio.StreamWriter.drain">

  516. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">drain</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.drain" title="Link to this definition">¶</a></dt>

  517. <dd><p>Wait until it is appropriate to resume writing to the stream.

  518. Example:</p>

  519. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">writer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  520. <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">drain</span><span class="p">()</span>

  521. </pre></div>

  522. </div>

  523. <p>This is a flow control method that interacts with the underlying

  524. IO write buffer.  When the size of the buffer reaches

  525. the high watermark, <em>drain()</em> blocks until the size of the

  526. buffer is drained down to the low watermark and writing can

  527. be resumed.  When there is nothing to wait for, the <a class="reference internal" href="#asyncio.StreamWriter.drain" title="asyncio.StreamWriter.drain"><code class="xref py py-meth docutils literal notranslate"><span class="pre">drain()</span></code></a>

  528. returns immediately.</p>

  529. </dd></dl>

  530. 

  531. <dl class="py method">

  532. <dt class="sig sig-object py" id="asyncio.StreamWriter.start_tls">

  533. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">start_tls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sslcontext</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_handshake_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_shutdown_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.start_tls" title="Link to this definition">¶</a></dt>

  534. <dd><p>Upgrade an existing stream-based connection to TLS.</p>

  535. <p>Parameters:</p>

  536. <ul class="simple">

  537. <li><p><em>sslcontext</em>: a configured instance of <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSLContext</span></code></a>.</p></li>

  538. <li><p><em>server_hostname</em>: sets or overrides the host name that the target

  539. server’s certificate will be matched against.</p></li>

  540. <li><p><em>ssl_handshake_timeout</em> is the time in seconds to wait for the TLS

  541. handshake to complete before aborting the connection.  <code class="docutils literal notranslate"><span class="pre">60.0</span></code> seconds

  542. if <code class="docutils literal notranslate"><span class="pre">None</span></code> (default).</p></li>

  543. <li><p><em>ssl_shutdown_timeout</em> is the time in seconds to wait for the SSL shutdown

  544. to complete before aborting the connection. <code class="docutils literal notranslate"><span class="pre">30.0</span></code> seconds if <code class="docutils literal notranslate"><span class="pre">None</span></code>

  545. (default).</p></li>

  546. </ul>

  547. <div class="versionadded">

  548. <p><span class="versionmodified added">New in version 3.11.</span></p>

  549. </div>

  550. <div class="versionchanged">

  551. <p><span class="versionmodified changed">Changed in version 3.12: </span>Added the <em>ssl_shutdown_timeout</em> parameter.</p>

  552. </div>

  553. </dd></dl>

  554. 

  555. <dl class="py method">

  556. <dt class="sig sig-object py" id="asyncio.StreamWriter.is_closing">

  557. <span class="sig-name descname"><span class="pre">is_closing</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.is_closing" title="Link to this definition">¶</a></dt>

  558. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the stream is closed or in the process of

  559. being closed.</p>

  560. <div class="versionadded">

  561. <p><span class="versionmodified added">New in version 3.7.</span></p>

  562. </div>

  563. </dd></dl>

  564. 

  565. <dl class="py method">

  566. <dt class="sig sig-object py" id="asyncio.StreamWriter.wait_closed">

  567. <em class="property"><span class="pre">coroutine</span> </em><span class="sig-name descname"><span class="pre">wait_closed</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#asyncio.StreamWriter.wait_closed" title="Link to this definition">¶</a></dt>

  568. <dd><p>Wait until the stream is closed.</p>

  569. <p>Should be called after <a class="reference internal" href="#asyncio.StreamWriter.close" title="asyncio.StreamWriter.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> to wait until the underlying

  570. connection is closed, ensuring that all data has been flushed

  571. before e.g. exiting the program.</p>

  572. <div class="versionadded">

  573. <p><span class="versionmodified added">New in version 3.7.</span></p>

  574. </div>

  575. </dd></dl>

  576. 

  577. </dd></dl>

  578. 

  579. </section>

  580. <section id="examples">

  581. <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>

  582. <section id="tcp-echo-client-using-streams">

  583. <span id="asyncio-tcp-echo-client-streams"></span><h3>TCP echo client using streams<a class="headerlink" href="#tcp-echo-client-using-streams" title="Link to this heading">¶</a></h3>

  584. <p>TCP echo client using the <a class="reference internal" href="#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.open_connection()</span></code></a> function:</p>

  585. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">asyncio</span>

  586. 

  587. <span class="k">async</span> <span class="k">def</span> <span class="nf">tcp_echo_client</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>

  588.     <span class="n">reader</span><span class="p">,</span> <span class="n">writer</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">open_connection</span><span class="p">(</span>

  589.         <span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span> <span class="mi">8888</span><span class="p">)</span>

  590. 

  591.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Send: </span><span class="si">{</span><span class="n">message</span><span class="si">!r}</span><span class="s1">&#39;</span><span class="p">)</span>

  592.     <span class="n">writer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>

  593.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">drain</span><span class="p">()</span>

  594. 

  595.     <span class="n">data</span> <span class="o">=</span> <span class="k">await</span> <span class="n">reader</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>

  596.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Received: </span><span class="si">{</span><span class="n">data</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span><span class="si">!r}</span><span class="s1">&#39;</span><span class="p">)</span>

  597. 

  598.     <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Close the connection&#39;</span><span class="p">)</span>

  599.     <span class="n">writer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  600.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">wait_closed</span><span class="p">()</span>

  601. 

  602. <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">tcp_echo_client</span><span class="p">(</span><span class="s1">&#39;Hello World!&#39;</span><span class="p">))</span>

  603. </pre></div>

  604. </div>

  605. <div class="admonition seealso">

  606. <p class="admonition-title">See also</p>

  607. <p>The <a class="reference internal" href="asyncio-protocol.html#asyncio-example-tcp-echo-client-protocol"><span class="std std-ref">TCP echo client protocol</span></a>

  608. example uses the low-level <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"><span class="pre">loop.create_connection()</span></code></a> method.</p>

  609. </div>

  610. </section>

  611. <section id="tcp-echo-server-using-streams">

  612. <span id="asyncio-tcp-echo-server-streams"></span><h3>TCP echo server using streams<a class="headerlink" href="#tcp-echo-server-using-streams" title="Link to this heading">¶</a></h3>

  613. <p>TCP echo server using the <a class="reference internal" href="#asyncio.start_server" title="asyncio.start_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.start_server()</span></code></a> function:</p>

  614. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">asyncio</span>

  615. 

  616. <span class="k">async</span> <span class="k">def</span> <span class="nf">handle_echo</span><span class="p">(</span><span class="n">reader</span><span class="p">,</span> <span class="n">writer</span><span class="p">):</span>

  617.     <span class="n">data</span> <span class="o">=</span> <span class="k">await</span> <span class="n">reader</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>

  618.     <span class="n">message</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>

  619.     <span class="n">addr</span> <span class="o">=</span> <span class="n">writer</span><span class="o">.</span><span class="n">get_extra_info</span><span class="p">(</span><span class="s1">&#39;peername&#39;</span><span class="p">)</span>

  620. 

  621.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Received </span><span class="si">{</span><span class="n">message</span><span class="si">!r}</span><span class="s2"> from </span><span class="si">{</span><span class="n">addr</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">)</span>

  622. 

  623.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Send: </span><span class="si">{</span><span class="n">message</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">)</span>

  624.     <span class="n">writer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  625.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">drain</span><span class="p">()</span>

  626. 

  627.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Close the connection&quot;</span><span class="p">)</span>

  628.     <span class="n">writer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  629.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">wait_closed</span><span class="p">()</span>

  630. 

  631. <span class="k">async</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span>

  632.     <span class="n">server</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">start_server</span><span class="p">(</span>

  633.         <span class="n">handle_echo</span><span class="p">,</span> <span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span> <span class="mi">8888</span><span class="p">)</span>

  634. 

  635.     <span class="n">addrs</span> <span class="o">=</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">sock</span><span class="o">.</span><span class="n">getsockname</span><span class="p">())</span> <span class="k">for</span> <span class="n">sock</span> <span class="ow">in</span> <span class="n">server</span><span class="o">.</span><span class="n">sockets</span><span class="p">)</span>

  636.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Serving on </span><span class="si">{</span><span class="n">addrs</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>

  637. 

  638.     <span class="k">async</span> <span class="k">with</span> <span class="n">server</span><span class="p">:</span>

  639.         <span class="k">await</span> <span class="n">server</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  640. 

  641. <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span>

  642. </pre></div>

  643. </div>

  644. <div class="admonition seealso">

  645. <p class="admonition-title">See also</p>

  646. <p>The <a class="reference internal" href="asyncio-protocol.html#asyncio-example-tcp-echo-server-protocol"><span class="std std-ref">TCP echo server protocol</span></a>

  647. example uses 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"><span class="pre">loop.create_server()</span></code></a> method.</p>

  648. </div>

  649. </section>

  650. <section id="get-http-headers">

  651. <h3>Get HTTP headers<a class="headerlink" href="#get-http-headers" title="Link to this heading">¶</a></h3>

  652. <p>Simple example querying HTTP headers of the URL passed on the command line:</p>

  653. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">asyncio</span>

  654. <span class="kn">import</span> <span class="nn">urllib.parse</span>

  655. <span class="kn">import</span> <span class="nn">sys</span>

  656. 

  657. <span class="k">async</span> <span class="k">def</span> <span class="nf">print_http_headers</span><span class="p">(</span><span class="n">url</span><span class="p">):</span>

  658.     <span class="n">url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlsplit</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>

  659.     <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">scheme</span> <span class="o">==</span> <span class="s1">&#39;https&#39;</span><span class="p">:</span>

  660.         <span class="n">reader</span><span class="p">,</span> <span class="n">writer</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">open_connection</span><span class="p">(</span>

  661.             <span class="n">url</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span> <span class="mi">443</span><span class="p">,</span> <span class="n">ssl</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

  662.     <span class="k">else</span><span class="p">:</span>

  663.         <span class="n">reader</span><span class="p">,</span> <span class="n">writer</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">open_connection</span><span class="p">(</span>

  664.             <span class="n">url</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span>

  665. 

  666.     <span class="n">query</span> <span class="o">=</span> <span class="p">(</span>

  667.         <span class="sa">f</span><span class="s2">&quot;HEAD </span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">path</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="s1">&#39;/&#39;</span><span class="si">}</span><span class="s2"> HTTP/1.0</span><span class="se">\r\n</span><span class="s2">&quot;</span>

  668.         <span class="sa">f</span><span class="s2">&quot;Host: </span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">hostname</span><span class="si">}</span><span class="se">\r\n</span><span class="s2">&quot;</span>

  669.         <span class="sa">f</span><span class="s2">&quot;</span><span class="se">\r\n</span><span class="s2">&quot;</span>

  670.     <span class="p">)</span>

  671. 

  672.     <span class="n">writer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">query</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;latin-1&#39;</span><span class="p">))</span>

  673.     <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>

  674.         <span class="n">line</span> <span class="o">=</span> <span class="k">await</span> <span class="n">reader</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>

  675.         <span class="k">if</span> <span class="ow">not</span> <span class="n">line</span><span class="p">:</span>

  676.             <span class="k">break</span>

  677. 

  678.         <span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;latin1&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>

  679.         <span class="k">if</span> <span class="n">line</span><span class="p">:</span>

  680.             <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;HTTP header&gt; </span><span class="si">{</span><span class="n">line</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>

  681. 

  682.     <span class="c1"># Ignore the body, close the socket</span>

  683.     <span class="n">writer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  684.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">wait_closed</span><span class="p">()</span>

  685. 

  686. <span class="n">url</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>

  687. <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">print_http_headers</span><span class="p">(</span><span class="n">url</span><span class="p">))</span>

  688. </pre></div>

  689. </div>

  690. <p>Usage:</p>

  691. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">example</span><span class="o">.</span><span class="n">py</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">page</span><span class="o">.</span><span class="n">html</span>

  692. </pre></div>

  693. </div>

  694. <p>or with HTTPS:</p>

  695. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">example</span><span class="o">.</span><span class="n">py</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">page</span><span class="o">.</span><span class="n">html</span>

  696. </pre></div>

  697. </div>

  698. </section>

  699. <section id="register-an-open-socket-to-wait-for-data-using-streams">

  700. <span id="asyncio-example-create-connection-streams"></span><h3>Register an open socket to wait for data using streams<a class="headerlink" href="#register-an-open-socket-to-wait-for-data-using-streams" title="Link to this heading">¶</a></h3>

  701. <p>Coroutine waiting until a socket receives data using the

  702. <a class="reference internal" href="#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">open_connection()</span></code></a> function:</p>

  703. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">asyncio</span>

  704. <span class="kn">import</span> <span class="nn">socket</span>

  705. 

  706. <span class="k">async</span> <span class="k">def</span> <span class="nf">wait_for_data</span><span class="p">():</span>

  707.     <span class="c1"># Get a reference to the current event loop because</span>

  708.     <span class="c1"># we want to access low-level APIs.</span>

  709.     <span class="n">loop</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">get_running_loop</span><span class="p">()</span>

  710. 

  711.     <span class="c1"># Create a pair of connected sockets.</span>

  712.     <span class="n">rsock</span><span class="p">,</span> <span class="n">wsock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socketpair</span><span class="p">()</span>

  713. 

  714.     <span class="c1"># Register the open socket to wait for data.</span>

  715.     <span class="n">reader</span><span class="p">,</span> <span class="n">writer</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">open_connection</span><span class="p">(</span><span class="n">sock</span><span class="o">=</span><span class="n">rsock</span><span class="p">)</span>

  716. 

  717.     <span class="c1"># Simulate the reception of data from the network</span>

  718.     <span class="n">loop</span><span class="o">.</span><span class="n">call_soon</span><span class="p">(</span><span class="n">wsock</span><span class="o">.</span><span class="n">send</span><span class="p">,</span> <span class="s1">&#39;abc&#39;</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>

  719. 

  720.     <span class="c1"># Wait for data</span>

  721.     <span class="n">data</span> <span class="o">=</span> <span class="k">await</span> <span class="n">reader</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>

  722. 

  723.     <span class="c1"># Got data, we are done: close the socket</span>

  724.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Received:&quot;</span><span class="p">,</span> <span class="n">data</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>

  725.     <span class="n">writer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  726.     <span class="k">await</span> <span class="n">writer</span><span class="o">.</span><span class="n">wait_closed</span><span class="p">()</span>

  727. 

  728.     <span class="c1"># Close the second socket</span>

  729.     <span class="n">wsock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  730. 

  731. <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">wait_for_data</span><span class="p">())</span>

  732. </pre></div>

  733. </div>

  734. <div class="admonition seealso">

  735. <p class="admonition-title">See also</p>

  736. <p>The <a class="reference internal" href="asyncio-protocol.html#asyncio-example-create-connection"><span class="std std-ref">register an open socket to wait for data using a protocol</span></a> example uses a low-level protocol and

  737. 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"><span class="pre">loop.create_connection()</span></code></a> method.</p>

  738. <p>The <a class="reference internal" href="asyncio-eventloop.html#asyncio-example-watch-fd"><span class="std std-ref">watch a file descriptor for read events</span></a> example uses the low-level

  739. <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"><span class="pre">loop.add_reader()</span></code></a> method to watch a file descriptor.</p>

  740. </div>

  741. </section>

  742. </section>

  743. </section>

  744. 

  745. 

  746.             <div class="clearer"></div>

  747.           </div>

  748.         </div>

  749.       </div>

  750.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  751.         <div class="sphinxsidebarwrapper">

  752.   <div>

  753.     <h3><a href="../contents.html">Table of Contents</a></h3>

  754.     <ul>

  755. <li><a class="reference internal" href="#">Streams</a><ul>

  756. <li><a class="reference internal" href="#streamreader">StreamReader</a></li>

  757. <li><a class="reference internal" href="#streamwriter">StreamWriter</a></li>

  758. <li><a class="reference internal" href="#examples">Examples</a><ul>

  759. <li><a class="reference internal" href="#tcp-echo-client-using-streams">TCP echo client using streams</a></li>

  760. <li><a class="reference internal" href="#tcp-echo-server-using-streams">TCP echo server using streams</a></li>

  761. <li><a class="reference internal" href="#get-http-headers">Get HTTP headers</a></li>

  762. <li><a class="reference internal" href="#register-an-open-socket-to-wait-for-data-using-streams">Register an open socket to wait for data using streams</a></li>

  763. </ul>

  764. </li>

  765. </ul>

  766. </li>

  767. </ul>

  768. 

  769.   </div>

  770.   <div>

  771.     <h4>Previous topic</h4>

  772.     <p class="topless"><a href="asyncio-task.html"

  773.                           title="previous chapter">Coroutines and Tasks</a></p>

  774.   </div>

  775.   <div>

  776.     <h4>Next topic</h4>

  777.     <p class="topless"><a href="asyncio-sync.html"

  778.                           title="next chapter">Synchronization Primitives</a></p>

  779.   </div>

  780.   <div role="note" aria-label="source link">

  781.     <h3>This Page</h3>

  782.     <ul class="this-page-menu">

  783.       <li><a href="../bugs.html">Report a Bug</a></li>

  784.       <li>

  785.         <a href="https://github.com/python/cpython/blob/main/Doc/library/asyncio-stream.rst"

  786.             rel="nofollow">Show Source

  787.         </a>

  788.       </li>

  789.     </ul>

  790.   </div>

  791.         </div>

  792. <div id="sidebarbutton" title="Collapse sidebar">

  793. <span>«</span>

  794. </div>

  795. 

  796.       </div>

  797.       <div class="clearer"></div>

  798.     </div>  

  799.     <div class="related" role="navigation" aria-label="related navigation">

  800.       <h3>Navigation</h3>

  801.       <ul>

  802.         <li class="right" style="margin-right: 10px">

  803.           <a href="../genindex.html" title="General Index"

  804.              >index</a></li>

  805.         <li class="right" >

  806.           <a href="../py-modindex.html" title="Python Module Index"

  807.              >modules</a> |</li>

  808.         <li class="right" >

  809.           <a href="asyncio-sync.html" title="Synchronization Primitives"

  810.              >next</a> |</li>

  811.         <li class="right" >

  812.           <a href="asyncio-task.html" title="Coroutines and Tasks"

  813.              >previous</a> |</li>

  814. 

  815.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  816.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  817.           <li class="switchers">

  818.             <div class="language_switcher_placeholder"></div>

  819.             <div class="version_switcher_placeholder"></div>

  820.           </li>

  821.           <li>

  822.               

  823.           </li>

  824.     <li id="cpython-language-and-version">

  825.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  826.     </li>

  827. 

  828.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  829.           <li class="nav-item nav-item-2"><a href="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>

  830.           <li class="nav-item nav-item-3"><a href="asyncio.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">asyncio</span></code> — Asynchronous I/O</a> &#187;</li>

  831.         <li class="nav-item nav-item-this"><a href="">Streams</a></li>

  832.                 <li class="right">

  833.                     

  834. 

  835.     <div class="inline-search" role="search">

  836.         <form class="inline-search" action="../search.html" method="get">

  837.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  838.           <input type="submit" value="Go" />

  839.         </form>

  840.     </div>

  841.                      |

  842.                 </li>

  843.             <li class="right">

  844. <label class="theme-selector-label">

  845.     Theme

  846.     <select class="theme-selector" oninput="activateTheme(this.value)">

  847.         <option value="auto" selected>Auto</option>

  848.         <option value="light">Light</option>

  849.         <option value="dark">Dark</option>

  850.     </select>

  851. </label> |</li>

  852.             

  853.       </ul>

  854.     </div>  

  855.     <div class="footer">

  856.     &copy; 

  857.       <a href="../copyright.html">

  858.     

  859.     Copyright

  860.     

  861.       </a>

  862.      2001-2024, Python Software Foundation.

  863.     <br />

  864.     This page is licensed under the Python Software Foundation License Version 2.

  865.     <br />

  866.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  867.     <br />

  868.     

  869.       See <a href="/license.html">History and License</a> for more information.<br />

  870.     

  871.     

  872.     <br />

  873. 

  874.     The Python Software Foundation is a non-profit corporation.

  875. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  876. <br />

  877.     <br />

  878.       Last updated on Apr 09, 2024 (13:47 UTC).

  879.     

  880.       <a href="/bugs.html">Found a bug</a>?

  881.     

  882.     <br />

  883. 

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

  885.     </div>

  886. 

  887.   </body>

  888. </html>
上海开阖软件有限公司 沪ICP备12045867号-1