summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-01-24 17:11:43 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-01-24 17:11:43 (GMT)
commit8c462c5a8027737244cb6654462eb3725e885cc4 (patch)
treef44516a6829592e309a46508d5d76d48473c2fd4
parentc3bf14d1ebce053852298d4a83d524afa670ffc7 (diff)
downloadcpython-8c462c5a8027737244cb6654462eb3725e885cc4.zip
cpython-8c462c5a8027737244cb6654462eb3725e885cc4.tar.gz
cpython-8c462c5a8027737244cb6654462eb3725e885cc4.tar.bz2
asyncio doc: move AbstractServer to the event loop page
Add also entries in the table of content for each synchronization primitive class.
-rw-r--r--Doc/library/asyncio-eventloop.rst16
-rw-r--r--Doc/library/asyncio-protocol.rst16
-rw-r--r--Doc/library/asyncio-sync.rst27
3 files changed, 43 insertions, 16 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index 6fc0c4c..953fa49 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -344,6 +344,22 @@ pool of processes). By default, an event loop uses a thread pool executor
Set the default executor used by :meth:`run_in_executor`.
+Server
+------
+
+.. class:: AbstractServer
+
+ Abstract server returned by :func:`BaseEventLoop.create_server`.
+
+ .. method:: close()
+
+ Stop serving. This leaves existing connections open.
+
+ .. method:: wait_closed()
+
+ Coroutine to wait until service is closed.
+
+
.. _asyncio-hello-world-callback:
Example: Hello World (callback)
diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
index d35c70d..8eb1d68 100644
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -415,22 +415,6 @@ coroutine with ``yield from``. For example, the :meth:`StreamWriter.drain`
coroutine can be used to wait until the write buffer is flushed.
-Server
-------
-
-.. class:: AbstractServer
-
- Abstract server returned by :func:`BaseEventLoop.create_server`.
-
- .. method:: close()
-
- Stop serving. This leaves existing connections open.
-
- .. method:: wait_closed()
-
- Coroutine to wait until service is closed.
-
-
Protocol example: TCP echo server and client
============================================
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
index 96ea012..5ac9f34 100644
--- a/Doc/library/asyncio-sync.rst
+++ b/Doc/library/asyncio-sync.rst
@@ -7,6 +7,9 @@ Synchronization primitives
Locks
-----
+Lock
+^^^^
+
.. class:: Lock(\*, loop=None)
Primitive lock objects.
@@ -85,6 +88,9 @@ Locks
There is no return value.
+Event
+^^^^^
+
.. class:: Event(\*, loop=None)
An Event implementation, asynchronous equivalent to :class:`threading.Event`.
@@ -121,6 +127,9 @@ Locks
This method returns a :ref:`coroutine object <coroutine>`.
+Condition
+^^^^^^^^^
+
.. class:: Condition(\*, loop=None)
A Condition implementation, asynchronous equivalent to
@@ -181,6 +190,9 @@ Locks
Semaphores
----------
+Semaphore
+^^^^^^^^^
+
.. class:: Semaphore(value=1, \*, loop=None)
A Semaphore implementation.
@@ -218,6 +230,9 @@ Semaphores
larger than zero again, wake up that coroutine.
+BoundedSemaphore
+^^^^^^^^^^^^^^^^
+
.. class:: BoundedSemaphore(value=1, \*, loop=None)
A bounded semaphore implementation. Inherit from :class:`Semaphore`.
@@ -229,6 +244,9 @@ Semaphores
Queues
------
+Queue
+^^^^^
+
.. class:: Queue(maxsize=0, \*, loop=None)
A queue, useful for coordinating producer and consumer coroutines.
@@ -294,6 +312,9 @@ Queues
Number of items allowed in the queue.
+PriorityQueue
+^^^^^^^^^^^^^
+
.. class:: PriorityQueue
A subclass of :class:`Queue`; retrieves entries in priority order (lowest
@@ -302,12 +323,18 @@ Queues
Entries are typically tuples of the form: (priority number, data).
+LifoQueue
+^^^^^^^^^
+
.. class:: LifoQueue
A subclass of :class:`Queue` that retrieves most recently added entries
first.
+JoinableQueue
+^^^^^^^^^^^^^
+
.. class:: JoinableQueue
A subclass of :class:`Queue` with :meth:`task_done` and :meth:`join`