traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

#9689: add links from overview to in-depth class API descriptions.

This commit is contained in:
Georg Brandl 2010-08-26 14:30:15 +00:00
parent 4bb5c273c6
commit 179249f493
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/library/threading.rst
View File

@ -33,6 +33,8 @@ This module defines the following functions and objects:
variable allows one or more threads to wait until they are notified by another variable allows one or more threads to wait until they are notified by another
thread. thread.
See :ref:`condition-objects`.
.. function:: current_thread() .. function:: current_thread()
@ -58,6 +60,8 @@ This module defines the following functions and objects:
with the :meth:`clear` method. The :meth:`wait` method blocks until the flag with the :meth:`clear` method. The :meth:`wait` method blocks until the flag
is true. is true.
See :ref:`event-objects`.
.. class:: local .. class:: local
@ -80,6 +84,8 @@ This module defines the following functions and objects:
acquired it, subsequent attempts to acquire it block, until it is released; any acquired it, subsequent attempts to acquire it block, until it is released; any
thread may release it. thread may release it.
See :ref:`lock-objects`.
.. function:: RLock() .. function:: RLock()
@ -88,6 +94,8 @@ This module defines the following functions and objects:
reentrant lock, the same thread may acquire it again without blocking; the reentrant lock, the same thread may acquire it again without blocking; the
thread must release it once for each time it has acquired it. thread must release it once for each time it has acquired it.
See :ref:`rlock-objects`.
.. function:: Semaphore(value=1) .. function:: Semaphore(value=1)
:noindex: :noindex:
@ -98,6 +106,8 @@ This module defines the following functions and objects:
if necessary until it can return without making the counter negative. If not if necessary until it can return without making the counter negative. If not
given, *value* defaults to 1. given, *value* defaults to 1.
See :ref:`semaphore-objects`.
.. function:: BoundedSemaphore(value=1) .. function:: BoundedSemaphore(value=1)
@ -109,15 +119,21 @@ This module defines the following functions and objects:
.. class:: Thread .. class:: Thread
:noindex:
A class that represents a thread of control. This class can be safely A class that represents a thread of control. This class can be safely
subclassed in a limited fashion. subclassed in a limited fashion.
See :ref:`thread-objects`.
.. class:: Timer .. class:: Timer
:noindex:
A thread that executes a function after a specified interval has passed. A thread that executes a function after a specified interval has passed.
See :ref:`timer-objects`.
.. function:: settrace(func) .. function:: settrace(func)