[Python-checkins] cpython (3.5): Issue #27392: Document loop.connect_accepted_socket()

[yury.selivanov]

https://hg.python.org/cpython/rev/3e6570231c80
changeset:   104949:3e6570231c80
branch:      3.5
parent:      104946:f4e86b1b051e
user:        Yury Selivanov <yury at magic.io>
date:        Mon Nov 07 15:35:25 2016 -0500
summary:
  Issue #27392: Document loop.connect_accepted_socket()

Patch by Jim Fulton.

files:
  Doc/library/asyncio-eventloop.rst |  17 +++++++++++++++++
  1 files changed, 17 insertions(+), 0 deletions(-)


diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -461,6 +461,23 @@
 
    Availability: UNIX.
 
+.. coroutinemethod:: BaseEventLoop.connect_accepted_socket(protocol_factory, sock, \*, ssl=None)
+
+   Handle an accepted connection.
+
+   This is used by servers that accept connections outside of
+   asyncio but that use asyncio to handle them.
+
+   Parameters:
+
+   * *sock* is a preexisting socket object returned from an ``accept``
+     call.
+
+   * *ssl* can be set to an :class:`~ssl.SSLContext` to enable SSL over the
+     accepted connections.
+
+   This method is a :ref:`coroutine <coroutine>`.  When completed, the
+   coroutine returns a ``(transport, protocol)`` pair.
 
 Watch file descriptors
 ----------------------

-- 
Repository URL: https://hg.python.org/cpython