From: Yury Selivanov <yury@magic.io>
Date: Mon, 7 Nov 2016 20:35:25 +0000 (-0500)
Subject: Issue #27392: Document loop.connect_accepted_socket()
X-Git-Tag: v3.6.0b4~138^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3b3a141a83a1e9141cecfdc1d2ee661f253b030c;p=thirdparty%2FPython%2Fcpython.git

Issue #27392: Document loop.connect_accepted_socket()

Patch by Jim Fulton.
---

diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index cf2f3d630c86..d7201601c59a 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -461,6 +461,23 @@ Creating listening connections
 
    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
 ----------------------