summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-02-01 02:18:58 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-02-01 02:18:58 (GMT)
commit606ab031c1e72af498d9417e4724ebf28539dafd (patch)
treef82ad2fb01500d87b1ff28e059afb61bf3626e13
parent45b27ed53db986d7829d2d0676ae7eb1fc567ed4 (diff)
downloadcpython-606ab031c1e72af498d9417e4724ebf28539dafd.zip
cpython-606ab031c1e72af498d9417e4724ebf28539dafd.tar.gz
cpython-606ab031c1e72af498d9417e4724ebf28539dafd.tar.bz2
asyncio doc: add "Concurrency and multithreading" section
-rw-r--r--Doc/library/asyncio-dev.rst30
-rw-r--r--Doc/library/asyncio-sync.rst2
2 files changed, 28 insertions, 4 deletions
diff --git a/Doc/library/asyncio-dev.rst b/Doc/library/asyncio-dev.rst
index 868e3f8..d89d350 100644
--- a/Doc/library/asyncio-dev.rst
+++ b/Doc/library/asyncio-dev.rst
@@ -7,6 +7,32 @@ Asynchronous programming is different than classical "sequential" programming.
This page lists common traps and explains how to avoid them.
+.. _asyncio-multithreading:
+
+Concurrency and multithreading
+------------------------------
+
+An event loop runs in a thread and executes all callbacks and tasks in the same
+thread. If a callback should be scheduled from a different thread, the
+:meth:`BaseEventLoop.call_soon_threadsafe` method should be used.
+
+While a task in running in the event loop, no other task is running in the same
+thread. But when the task uses ``yield from``, the task is suspended and the
+event loop executes the next task.
+
+To handle signals and to execute subprocesses, the event loop must be run in
+the main thread.
+
+The :meth:`BaseEventLoop.run_in_executor` method can be used with a thread pool
+executor to execute a callback in different thread to not block the thread of
+the event loop.
+
+.. seealso::
+
+ See the :ref:`Synchronization primitives <asyncio-sync>` section to
+ synchronize tasks.
+
+
.. _asyncio-handle-blocking:
Handle correctly blocking functions
@@ -21,7 +47,7 @@ APIs like :ref:`protocols <protocol>`.
An executor can be used to run a task in a different thread or even in a
different process, to not block the thread of the event loop. See the
-:func:`BaseEventLoop.run_in_executor` function.
+:meth:`BaseEventLoop.run_in_executor` method.
.. seealso::
@@ -213,5 +239,3 @@ Or without ``asyncio.async()``::
yield from asyncio.sleep(2.0)
loop.stop()
-.. XXX: Document "poll xxx" log message?
-
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
index e125951..19e49ff 100644
--- a/Doc/library/asyncio-sync.rst
+++ b/Doc/library/asyncio-sync.rst
@@ -1,5 +1,5 @@
.. currentmodule:: asyncio
-.. _sync:
+.. _asyncio-sync:
Synchronization primitives
==========================