autodoc.git
/
modref
/
ex
/
predef_3A_3A
/
ADT
/
Scheduler.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/modref/ex/predef_3A_3A/ADT/Scheduler.html:1:
+
<html>
+
<head>
+
<title>Pike Reference Manual - ADT.Scheduler</title>
+
<link rel='stylesheet' href='../../../style.css' />
+
<style type='text/css'>
+
svg line { stroke:#343434; stroke-width:2; }
+
svg text { fill:#343434; }
+
svg a { fill:#0768b2; text-decoration: underline; }
+
</style>
-
+
</head>
+
<body link="#0768b2" alink="#002040" vlink="#0768b2">
+
<header>
+
<div>
+
<div style="text-align:right;">Extracted from as of .</div>
+
<div style="overflow:hidden;">
+
<a href="http://pike.lysator.liu.se/"
+
style="float:left; width:181px; height:41px; margin:10px;
+
margin-left:22px; margin-right:25px;
+
background-image:url('../../../../images/pike_logo.gif');"></a>
+
<div style="margin:10px; height:11px;
+
margin-top:26px; margin-right:19px;
+
overflow:hidden;
+
background-image:url('../../../../images/pike_line_middle.gif');">
+
<span style="float:left; width:5px; height:11px;
+
background-image:url('../../../../images/pike_line_left.gif');"> </span>
+
<span style="float:right; width:5px; height:11px;
+
background-image:url('../../../../images/pike_line_right.gif');"> </span>
+
</div>
+
</div>
+
</div>
+
</header>
+
+
<div>
+
<div class="navbar">
+
<nav>
+
<a href='../../../index.html'><b class='top head'>Top</b></a>
+
<a href='../../../ex/predef_3A_3A/ADT.html'><b class='head'>ADT</b></a>
+
<b class='selected head'>ADT.Scheduler</b>
+
<script></script>
+
<noscript>
+
<div class='sidebar'>
+
<a href='../../../ex/predef_3A_3A/ADT/Scheduler/index.html'><b>Symbol index</b></a><br />
+
</div>
+
</noscript>
+
+
</nav>
+
</div>
+
<div class="navbox">
+
<nav>
+
<div class="sidebar">
+
<a href="../../../ex/predef_3A_3A/ADT/Queue/cast.html" class="left"
+
><img src="../../../../images/prev.gif" hspace="3"
+
border="0" alt="previous"
+
>ADT.Queue()->cast()</a>
+
<a href="../../../ex/predef_3A_3A/ADT/Scheduler/Consumer.html" class="right"
+
>ADT.Scheduler()->Consumer<img src="../../../../images/next.gif" hspace="3"
+
border="0" alt="next"
+
></a>
+
</div>
+
</nav>
+
</div>
+
<div class="contentbox">
+
<article>
+
<h1>Class ADT.Scheduler</h1>
+
+
<dt class='head--doc'>Inheritance graph</dt>
+
<div class='inheritance-graph'><svg xmlns='http://www.w3.org/2000/svg' version='1.1' xmlns:xlink='http://www.w3.org/1999/xlink' xml:space='preserve' width='100%' height='45px'>
+
<text x='0' y='20'><a class='ms reference' xlink:href='../../predef_3A_3A/ADT/Heap.html'>ADT.Heap</a></text>
+
<line x1='4' y1='35' x2='35' y2='35' />
+
<line x1='5' y1='25' x2='5' y2='36' />
+
<text x='40' y='40'><tspan style='font-family:monospace; font-weight:bold;'>ADT.Scheduler</tspan></text>
+
</svg></div>
+
<dl class='group--doc'>
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>This class implements a quantized resource scheduler.</p>
+
<p> Weighted consumers are added to the scheduler with <a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/add.html'>add()</a>,
+
which returns a <a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/Consumer.html'>Consumer</a> object.</p>
+
<p> When there's some of the resource available to be consumed
+
the resource owner calls <a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/get.html'>get()</a>, which returns the
+
<a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/Consumer.html'>Consumer</a> that is to use the resource. <a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/Consumer/consume.html'>Consumer()->consume()</a>
+
is then called with the fraction of the quanta that was consumed
+
(typically <code class='expr'>1.0</code>). The amount of resources allocated to a
+
consumer is proportional to the weight of the consumer.</p>
+
<p> A consumer may be temporarily deactivated (in which case it won't
+
be returned by <a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/get.html'>get()</a>, but still retain its share of the resource
+
which will be provided later by <a class='ms reference' href='../../predef_3A_3A/ADT/Scheduler/get.html'>get()</a> when it has been reactivated.</p>
+
</dd></dl>
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Inherit</span>
+
<span class='homogen--name'><b>Heap</b></span>
+
</dt>
+
<dd><p><code><span class='datatype'><code class='modifier'>protected</code> inherit </span><a class='ms reference' href='../../predef_3A_3A/ADT/Heap.html'>.Heap</a> : <span class='inherit'>Heap</span></code></p></dd>
+
</dl>
+
+
</article>
+
<footer>
+
<hr size="1" noshade="1" />
+
</footer>
+
</div>
+
</div>
+
</body>
+
<script>PikeDoc.current = {"link":"ex/predef_3A_3A/ADT/Scheduler.html","name":"Scheduler"};</script>
+
<script src='../../../ex/predef_3A_3A/ADT/index.js'></script>
+
<script src='../../../ex/predef_3A_3A/ADT/Scheduler/load_index.js'></script>
+
</html>
Newline at end of file added.