[Python-checkins] CVS: python/dist/src/Doc/lib libthreading.tex,1.10,1.11

[Martin v. L?wis]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv28325/Doc/lib

Modified Files:
	libthreading.tex 
Log Message:
Patch #428326: New class threading.Timer.


Index: libthreading.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libthreading.tex,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** libthreading.tex	2001/08/20 18:49:00	1.10
--- libthreading.tex	2001/09/05 13:44:54	1.11
***************
*** 83,86 ****
--- 83,90 ----
  \end{classdesc*}
  
+ \begin{classdesc*}{Timer}{}
+ A thread that executes a function after a specified interval has passed.
+ \end{classdesc*}
+ 
  Detailed interfaces for the objects are documented below.  
  
***************
*** 595,597 ****
--- 599,633 ----
  The entire Python program exits when no active non-daemon
  threads are left.
+ \end{methoddesc}
+ 
+ 
+ \subsection{Timer Objects \label{timer-objects}}
+ 
+ This class represents an action that should be run only after a certain amount
+ of time has passed --- a timer. \class{Timer} is a subclass of \class{Thread} and
+ as such also functions as an example of creating custom threads.
+ 
+ Timers are started, as with threads, by calling their \method{start()} method. The
+ timer can be stopped (before its action has begun) by calling the
+ \method{cancel()} method. The interval the timer will wait before executing
+ its action may not be exactly the same as the interval specified by the
+ user.
+ 
+ For example:
+ \begin{verbatim}
+ def hello():
+     print "hello, world"
+ 
+ t = Timer(30.0, hello)
+ t.start() # after 30 seconds, "hello, world" will be printed
+ \end{verbatim}
+ 
+ \begin{classdesc}{Timer}{interval, function, args=[], kwargs=\{\}}
+ Create a timer that will run \var{function} with arguments \var{args} and 
+ keyword arguments \var{kwargs}, after \var{interval} seconds have passed.
+ \end{classdesc}
+ 
+ \begin{methoddesc}{cancel}{}
+ Stop the timer, and cancel the execution of the timer's action. This will only
+ work if the timer is still in its waiting stage.
  \end{methoddesc}