diff options
| author | Carlosgg <carlosgilglez@gmail.com> | 2023-09-07 23:37:20 +0100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2023-12-14 13:06:39 +1100 |
| commit | 05d3b223011a88a10c806be866db8e0d29f1e348 (patch) | |
| tree | 056faa4aec93513f0328895607a9bb77c9b35370 /docs/library/asyncio.rst | |
| parent | bfd6ad94ff950a4b7e3a2125db1539c5e4ca333a (diff) | |
docs/library: Document SSLContext cert methods and asyncio support.
Add `load_cert_chain`, `load_verify_locations`, `get_ciphers` and
`set_ciphers` SSLContext methods in ssl library, and update asyncio
`open_connection` and `start_server` methods with ssl support.
Signed-off-by: Carlos Gil <carlosgilglez@gmail.com>
Diffstat (limited to 'docs/library/asyncio.rst')
| -rw-r--r-- | docs/library/asyncio.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/library/asyncio.rst b/docs/library/asyncio.rst index 9a2c14e7e..b57f1ee04 100644 --- a/docs/library/asyncio.rst +++ b/docs/library/asyncio.rst @@ -201,10 +201,12 @@ class Lock TCP stream connections ---------------------- -.. function:: open_connection(host, port) +.. function:: open_connection(host, port, ssl=None) Open a TCP connection to the given *host* and *port*. The *host* address will be resolved using `socket.getaddrinfo`, which is currently a blocking call. + If *ssl* is a `ssl.SSLContext` object, this context is used to create the transport; + if *ssl* is ``True``, a default context is used. Returns a pair of streams: a reader and a writer stream. Will raise a socket-specific ``OSError`` if the host could not be resolved or if @@ -212,12 +214,14 @@ TCP stream connections This is a coroutine. -.. function:: start_server(callback, host, port, backlog=5) +.. function:: start_server(callback, host, port, backlog=5, ssl=None) Start a TCP server on the given *host* and *port*. The *callback* will be called with incoming, accepted connections, and be passed 2 arguments: reader and writer streams for the connection. + If *ssl* is a `ssl.SSLContext` object, this context is used to create the transport. + Returns a `Server` object. This is a coroutine. |