[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / lib / module-sched.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-mutex.html" />
<link rel="prev" href="module-time.html" />
<link rel="parent" href="allos.html" />
<link rel="next" href="scheduler-objects.html" />
<meta name='aesop' content='information' />
<title>6.12 sched -- Event scheduler</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.11 time  "
  href="module-time.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6. Generic Operating System"
  href="allos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.12.1 Scheduler Objects"
  href="scheduler-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-time.html">6.11 time  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="allos.html">6. Generic Operating System</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="scheduler-objects.html">6.12.1 Scheduler Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0081200000000000000000">
6.12 <tt class="module">sched</tt> --
         Event scheduler</A>
</H1>

<P>
<A NAME="module-sched"></A>

<P>
The <tt class="module">sched</tt> module defines a class which implements a general
purpose event scheduler:<a id='l2h-1981' xml:id='l2h-1981'></a>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-1980' xml:id='l2h-1980' class="class">scheduler</tt></b>(</nobr></td>
  <td><var>timefunc, delayfunc</var>)</td></tr></table></dt>
<dd>
The <tt class="class">scheduler</tt> class defines a generic interface to scheduling
events. It needs two functions to actually deal with the ``outside world''
-- <var>timefunc</var> should be callable without arguments, and return 
a number (the ``time'', in any units whatsoever).  The <var>delayfunc</var>
function should be callable with one argument, compatible with the output
of <var>timefunc</var>, and should delay that many time units.
<var>delayfunc</var> will also be called with the argument <code>0</code> after
each event is run to allow other threads an opportunity to run in
multi-threaded applications.
</dl>

<P>
Example:

<P>
<div class="verbatim"><pre>
&gt;&gt;&gt; import sched, time
&gt;&gt;&gt; s=sched.scheduler(time.time, time.sleep)
&gt;&gt;&gt; def print_time(): print "From print_time", time.time()
...
&gt;&gt;&gt; def print_some_times():
...     print time.time()
...     s.enter(5, 1, print_time, ())
...     s.enter(10, 1, print_time, ())
...     s.run()
...     print time.time()
...
&gt;&gt;&gt; print_some_times()
930343690.257
From print_time 930343695.274
From print_time 930343700.273
930343700.276
</pre></div>

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="scheduler-objects.html">6.12.1 Scheduler Objects</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.11 time  "
  href="module-time.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6. Generic Operating System"
  href="allos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.12.1 Scheduler Objects"
  href="scheduler-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-time.html">6.11 time  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="allos.html">6. Generic Operating System</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="scheduler-objects.html">6.12.1 Scheduler Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="module-mutex.html" />
	13	<link rel="prev" href="module-time.html" />
	14	<link rel="parent" href="allos.html" />
	15	<link rel="next" href="scheduler-objects.html" />
	16	<meta name='aesop' content='information' />
	17	<title>6.12 sched -- Event scheduler</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="6.11 time "
	25	href="module-time.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="6. Generic Operating System"
	28	href="allos.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="6.12.1 Scheduler Objects"
	31	href="scheduler-objects.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="module-time.html">6.11 time </A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="allos.html">6. Generic Operating System</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="scheduler-objects.html">6.12.1 Scheduler Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION0081200000000000000000">
	56	6.12 <tt class="module">sched</tt> --
	57	Event scheduler</A>
	58	</H1>
	59
	60	<P>
	61	<A NAME="module-sched"></A>
	62
	63	<P>
	64	The <tt class="module">sched</tt> module defines a class which implements a general
65	purpose event scheduler:<a id='l2h-1981' xml:id='l2h-1981'></a>
66
67	<P>
68	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
69	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-1980' xml:id='l2h-1980' class="class">scheduler</tt></b>(</nobr></td>
70	<td><var>timefunc, delayfunc</var>)</td></tr></table></dt>
71	<dd>
72	The <tt class="class">scheduler</tt> class defines a generic interface to scheduling
73	events. It needs two functions to actually deal with the ``outside world''
74	-- <var>timefunc</var> should be callable without arguments, and return
75	a number (the ``time'', in any units whatsoever). The <var>delayfunc</var>
76	function should be callable with one argument, compatible with the output
77	of <var>timefunc</var>, and should delay that many time units.
78	<var>delayfunc</var> will also be called with the argument <code>0</code> after
79	each event is run to allow other threads an opportunity to run in
80	multi-threaded applications.
81	</dl>
82
83	<P>
84	Example:
85
86	<P>
87	<div class="verbatim"><pre>
88	>>> import sched, time
89	>>> s=sched.scheduler(time.time, time.sleep)
90	>>> def print_time(): print "From print_time", time.time()
91	...
92	>>> def print_some_times():
93	... print time.time()
94	... s.enter(5, 1, print_time, ())
95	... s.enter(10, 1, print_time, ())
96	... s.run()
97	... print time.time()
98	...
99	>>> print_some_times()
100	930343690.257
101	From print_time 930343695.274
102	From print_time 930343700.273
103	930343700.276
104	</pre></div>
105
106	<P>
107
108	<p><br /></p><hr class='online-navigation' />
109	<div class='online-navigation'>
110	<!--Table of Child-Links-->
111	<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>
112
113	<UL CLASS="ChildLinks">
114	<LI><A href="scheduler-objects.html">6.12.1 Scheduler Objects</a>
115	</ul>
116	<!--End of Table of Child-Links-->
117	</div>
118
119	<DIV CLASS="navigation">
120	<div class='online-navigation'>
121	<p></p><hr />
122	<table align="center" width="100%" cellpadding="0" cellspacing="2">
123	<tr>
124	<td class='online-navigation'><a rel="prev" title="6.11 time "
125	href="module-time.html"><img src='../icons/previous.png'
126	border='0' height='32' alt='Previous Page' width='32' /></A></td>
127	<td class='online-navigation'><a rel="parent" title="6. Generic Operating System"
128	href="allos.html"><img src='../icons/up.png'
129	border='0' height='32' alt='Up One Level' width='32' /></A></td>
130	<td class='online-navigation'><a rel="next" title="6.12.1 Scheduler Objects"
131	href="scheduler-objects.html"><img src='../icons/next.png'
132	border='0' height='32' alt='Next Page' width='32' /></A></td>
133	<td align="center" width="100%">Python Library Reference</td>
134	<td class='online-navigation'><a rel="contents" title="Table of Contents"
135	href="contents.html"><img src='../icons/contents.png'
136	border='0' height='32' alt='Contents' width='32' /></A></td>
137	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
138	border='0' height='32' alt='Module Index' width='32' /></a></td>
139	<td class='online-navigation'><a rel="index" title="Index"
140	href="genindex.html"><img src='../icons/index.png'
141	border='0' height='32' alt='Index' width='32' /></A></td>
142	</tr></table>
143	<div class='online-navigation'>
144	<b class="navlabel">Previous:</b>
145	<a class="sectref" rel="prev" href="module-time.html">6.11 time </A>
146	<b class="navlabel">Up:</b>
147	<a class="sectref" rel="parent" href="allos.html">6. Generic Operating System</A>
148	<b class="navlabel">Next:</b>
149	<a class="sectref" rel="next" href="scheduler-objects.html">6.12.1 Scheduler Objects</A>
150	</div>
151	</div>
152	<hr />
153	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
154	</DIV>
155	<!--End of Navigation Panel-->
156	<ADDRESS>
157	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
158	</ADDRESS>
159	</BODY>
160	</HTML>