/usr/share/doc/libucommon-dev/a00170.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::TimerQueue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00170.html">TimerQueue</a>
</div>
</div>
<div class="contents">
<h1>ucc::TimerQueue Class Reference</h1><!-- doxytag: class="ucc::TimerQueue" --><!-- doxytag: inherits="ucc::OrderedIndex" -->
<p>A timer queue for timer events.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00209_source.html">timers.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::TimerQueue:</div>
<div class="dynsection">
<div class="center"><img src="a00574.png" border="0" usemap="#ucc_1_1_timer_queue_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_timer_queue_inherit__map" id="ucc_1_1_timer_queue_inherit__map">
<area shape="rect" id="node2" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="5,5,144,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::TimerQueue:</div>
<div class="dynsection">
<div class="center"><img src="a00575.png" border="0" usemap="#ucc_1_1_timer_queue_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_timer_queue_coll__map" id="ucc_1_1_timer_queue_coll__map">
<area shape="rect" id="node2" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="8,299,147,328"/><area shape="rect" id="node4" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,187,149,216"/><area shape="rect" id="node6" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,96,144,125"/><area shape="rect" id="node8" href="a00093.html" title="A common base class for all managed objects." alt="" coords="31,5,124,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html">event</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A timer event object that lives on a timer queue. <a href="a00171.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#ae9c40c8af85a309da305f5c9f62928c3">expire</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process timer queue and find when next event triggers. <a href="#ae9c40c8af85a309da305f5c9f62928c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#a295356e4dc204ebe3f24baddff5d3b82">operator+=</a> (<a class="el" href="a00171.html">event</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a timer event to the timer queue. <a href="#a295356e4dc204ebe3f24baddff5d3b82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#a8a7365c2776bfd812623d939b3ec67fb">operator-=</a> (<a class="el" href="a00171.html">event</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a timer event from the timer queue. <a href="#a8a7365c2776bfd812623d939b3ec67fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ba68e8f8adffa0fa4a89896f7bd2447"></a><!-- doxytag: member="ucc::TimerQueue::TimerQueue" ref="a8ba68e8f8adffa0fa4a89896f7bd2447" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#a8ba68e8f8adffa0fa4a89896f7bd2447">TimerQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty timer queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef0c7e3fcefa8139fb0d96e4c0134913"></a><!-- doxytag: member="ucc::TimerQueue::~TimerQueue" ref="aef0c7e3fcefa8139fb0d96e4c0134913" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#aef0c7e3fcefa8139fb0d96e4c0134913">~TimerQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy queue, does not remove event objects. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#ab75d40861a84a0d5b43e67591d333a8e">modify</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called in derived class when the queue is being modified. <a href="#ab75d40861a84a0d5b43e67591d333a8e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00170.html#abdeeaf8e07d8a6747feb417f03ef77c5">update</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called in derived class after the queue has been modified. <a href="#abdeeaf8e07d8a6747feb417f03ef77c5"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d89b86d8d3ce5a695bf16fd20830463"></a><!-- doxytag: member="ucc::TimerQueue::event" ref="a4d89b86d8d3ce5a695bf16fd20830463" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>event</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A timer queue for timer events. </p>
<p>The timer queue is used to hold a linked list of timers that must be processed together. The timer queue processes the timer event list and calls an expired function on events that have expired. The timer queue also determines the wait time until the next timer will expire. When timer events are modified, they can retrigger the queue to re-examine the list to find when the next timer will now expire. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00209_source.html#l00251">251</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae9c40c8af85a309da305f5c9f62928c3"></a><!-- doxytag: member="ucc::TimerQueue::expire" ref="ae9c40c8af85a309da305f5c9f62928c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::TimerQueue::expire </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Process timer queue and find when next event triggers. </p>
<p>This function will call the expired methods on expired timers. Normally this function will be called in the context of a timer thread which sleeps for the timeout returned unless it is awoken on an update event. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>timeout until next timer expires in milliseconds. </dd></dl>
</div>
</div>
<a class="anchor" id="ab75d40861a84a0d5b43e67591d333a8e"></a><!-- doxytag: member="ucc::TimerQueue::modify" ref="ab75d40861a84a0d5b43e67591d333a8e" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::TimerQueue::modify </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called in derived class when the queue is being modified. </p>
<p>This is often used to lock the list. </p>
</div>
</div>
<a class="anchor" id="a295356e4dc204ebe3f24baddff5d3b82"></a><!-- doxytag: member="ucc::TimerQueue::operator+=" ref="a295356e4dc204ebe3f24baddff5d3b82" args="(event &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::TimerQueue::operator+= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00171.html">event</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a timer event to the timer queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>event to add. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8a7365c2776bfd812623d939b3ec67fb"></a><!-- doxytag: member="ucc::TimerQueue::operator-=" ref="a8a7365c2776bfd812623d939b3ec67fb" args="(event &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::TimerQueue::operator-= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00171.html">event</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a timer event from the timer queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>event to remove. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abdeeaf8e07d8a6747feb417f03ef77c5"></a><!-- doxytag: member="ucc::TimerQueue::update" ref="abdeeaf8e07d8a6747feb417f03ef77c5" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::TimerQueue::update </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called in derived class after the queue has been modified. </p>
<p>This often releases a lock that modify set and to wakeup a timer thread to evaluate when the next timer will now expire. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00209_source.html">timers.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:52 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|