/usr/share/doc/libjuce/apiref/classTimeSliceClient.html is in libjuce-doc 4.3.0~repack-1.
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 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: TimeSliceClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classTimeSliceClient-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TimeSliceClient Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Used by the <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a> class.
<a href="classTimeSliceClient.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TimeSliceClient:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classTimeSliceClient.png" usemap="#TimeSliceClient_map" alt=""/>
<map id="TimeSliceClient_map" name="TimeSliceClient_map">
<area href="classBufferingAudioReader.html" title="An AudioFormatReader that uses a background thread to pre-read data from another reader. " alt="BufferingAudioReader" shape="rect" coords="0,56,138,80"/>
<area href="classBufferingAudioSource.html" title="An AudioSource which takes another source as input, and buffers it using a thread. " alt="BufferingAudioSource" shape="rect" coords="148,56,286,80"/>
<area href="classDirectoryContentsList.html" title="A class to asynchronously scan for details about the files in a directory. " alt="DirectoryContentsList" shape="rect" coords="296,56,434,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab97fd6407f33b2004534066c0b959e61"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceClient.html#ab97fd6407f33b2004534066c0b959e61">~TimeSliceClient</a> ()</td></tr>
<tr class="memdesc:ab97fd6407f33b2004534066c0b959e61"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab97fd6407f33b2004534066c0b959e61">More...</a><br /></td></tr>
<tr class="separator:ab97fd6407f33b2004534066c0b959e61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a272b0868c9bd0b5c281cf09dbaa69a9c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceClient.html#a272b0868c9bd0b5c281cf09dbaa69a9c">useTimeSlice</a> ()=0</td></tr>
<tr class="memdesc:a272b0868c9bd0b5c281cf09dbaa69a9c"><td class="mdescLeft"> </td><td class="mdescRight">Called back by a <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a>. <a href="#a272b0868c9bd0b5c281cf09dbaa69a9c">More...</a><br /></td></tr>
<tr class="separator:a272b0868c9bd0b5c281cf09dbaa69a9c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used by the <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a> class. </p>
<p>To register your class with a <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a>, derive from this class and use the <a class="el" href="classTimeSliceThread.html#ac8244dfb9ed53d0c8b10d301d8897d8f" title="Adds a client to the list. ">TimeSliceThread::addTimeSliceClient()</a> method to add it to the list.</p>
<p>Make sure you always call <a class="el" href="classTimeSliceThread.html#a07b538bee2ba11da5b66bd59af25f153" title="Removes a client from the list. ">TimeSliceThread::removeTimeSliceClient()</a> before deleting your client!</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab97fd6407f33b2004534066c0b959e61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab97fd6407f33b2004534066c0b959e61">§ </a></span>~TimeSliceClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual TimeSliceClient::~TimeSliceClient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a272b0868c9bd0b5c281cf09dbaa69a9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a272b0868c9bd0b5c281cf09dbaa69a9c">§ </a></span>useTimeSlice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int TimeSliceClient::useTimeSlice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called back by a <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a>. </p>
<p>When you register this class with it, a <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a> will repeatedly call this method.</p>
<p>The implementation of this method should use its time-slice to do something that's quick - never block for longer than absolutely necessary.</p>
<dl class="section return"><dt>Returns</dt><dd>Your method should return the number of milliseconds which it would like to wait before being called again. Returning 0 will make the thread call again as soon as possible (after possibly servicing other busy clients). If you return a value below zero, your client will be removed from the list of clients, and won't be called again. The value you specify isn't a guaranteee, and is only used as a hint by the thread - the actual time before the next callback may be more or less than specified. You can force the <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a> to wake up and poll again immediately by calling its notify() method. </dd></dl>
<p>Referenced by <a class="el" href="classBufferingAudioSource.html#ad5db3f567c5b68306f23fb3fed5367c0">BufferingAudioSource::isLooping()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__TimeSliceThread_8h.html">juce_TimeSliceThread.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|