This file is indexed.

/usr/share/gtk-doc/html/UPower/QoS.html is in upower-doc 0.9.23-2ubuntu1.

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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UPower.QoS</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="UPower Reference Manual">
<link rel="up" href="ref-dbus.html" title="D-Bus API Reference">
<link rel="prev" href="Device.html" title="org.freedesktop.UPower.Device">
<link rel="next" href="KbdBacklight.html" title="org.freedesktop.UPower.KbdBacklight">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="Device.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">UPower Reference Manual</th>
<td><a accesskey="n" href="KbdBacklight.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#QoS.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#QoS.description" class="shortcut">Description</a>
                   | 
                  <a href="#QoS.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#QoS.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="QoS"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">org.freedesktop.UPower.QoS</span></h2>
<p>org.freedesktop.UPower.QoS — QoS interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis"><a class="link" href="QoS.html#QoS.SetMinimumLatency">SetMinimumLatency</a>(in's'type,
in'i'value)
<a class="link" href="QoS.html#QoS.RequestLatency">RequestLatency</a>(in's'type,
in'i'value,
in'b'persistent,
out'u'cookie)
<a class="link" href="QoS.html#QoS.CancelRequest">CancelRequest</a>(in'u'cookie)
<a class="link" href="QoS.html#QoS.GetLatency">GetLatency</a>(in's'type,
out'i'value)
<a class="link" href="QoS.html#QoS.GetLatencyRequests">GetLatencyRequests</a>(out'a(uuusxbssi)'requests)
</pre>
</div>
<div class="refsect1">
<a name="id-1.2.5.4"></a><h2>Signals</h2>
<pre class="synopsis"><a class="link" href="QoS.html#QoS::LatencyChanged">LatencyChanged</a>('s'type,
'i'value)
<a class="link" href="QoS.html#QoS::RequestsChanged">RequestsChanged</a>()
</pre>
</div>
<div class="refsect1">
<a name="id-1.2.5.5"></a><h2>Implemented Interfaces</h2>
<p>
    Objects implementing org.freedesktop.UPower.QoS also implements
    org.freedesktop.DBus.Introspectable,
    org.freedesktop.DBus.Properties
    </p>
</div>
<div class="refsect1">
<a name="id-1.2.5.6"></a><h2>Description</h2>
<p>
      
        </p>
<p>
          org.freedesktop.UPower.QoS is a DBus interface implemented
          by UPower.
          It allows applications to request latencies, for example a couple of seconds
          for an IM application, or a few hundred microseconds for a multiplayer game.
        </p>
<p>
        </p>
<p>
          Use cases:
        </p>
<p>
        
          
            </p>
<p>
              I want my IM application to request 0.5s latency for messages.
            </p>
<p>
            </p>
<p>
              I'm running an OpenGL simulation and want maximum performance,
              even when on battery power.
            </p>
<p>
            </p>
<p>
              I'm running an SQL server for a credit card company, and want the
              server to request low latency CPU and network as any delay costs money.
            </p>
<p>
            </p>
<p>
              I'm an admin, and want to change the power consumption vs. latency
              from cron scripts so it uses high latency during the night for
              maximum power saving, and low latency during business hours.
            </p>
<p>
            </p>
<p>
              I want high throughput when copying files, but want low throughput
              for downloading updates in the background.
            </p>
<p>
            </p>
<p>
              I want my power manager to set all latencies to lowest when on
              AC power.
            </p>
<p>
            </p>
<p>
              I don't want my users messing with latency settings.
            </p>
<p>
            </p>
<p>
              I'm and admin and I want to be able to override all latency
              settings on my machines.
            </p>
<p>
          
        
        </p>
<p>
          Why don't applications use the PMQoS interface directly?
          By providing a framework we can override requests by policy, and also
          control requests from random services.
          You also can't set latencies unless you're the root user, which is not
          suitable for the desktop use case.
        </p>
<p>
        </p>
<p>
          Of course, you can do if you really want, but then you loose the
          benefits of the query interface and the policy override,
          and have to run your application as root.
        </p>
<p>
      
    </p>
</div>
<div class="refsect1">
<a name="id-1.2.5.7"></a><h2>Details</h2>
<div class="refsect2">
<a name="id-1.2.5.7.2"></a><h3>
<a name="QoS.SetMinimumLatency"></a>SetMinimumLatency ()</h3>
<pre class="programlisting">SetMinimumLatency (in's'type,
in'i'value)</pre>
</div>
<p>
            Set the minimum acceptable latency of the system.
            Setting this value tells the system to not attempt latencies below this setting.
            This may be useful in a data center or server room, when you want to override the
            latency requests from applications.
            This may be required if the server room is operating outside a standard thermal
            or power envelope, and an override is required.
            You do not have to use this method during normal operation.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>:</span></p></td>
<td>
            The type of latency to control, <code class="literal">cpu_dma</code> or
            <code class="literal">network</code>.
          </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>:</span></p></td>
<td>
            The value, in microseconds or kilobits per second.
            The value <code class="literal">-1</code> means unset and the default is used.
          </td>
</tr>
</tbody>
</table></div>
<div class="refsect3">
<a name="id-1.2.5.7.5"></a><h4>Errors</h4>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>org.freedesktop.UPower.GeneralError</code></em>:</span></p></td>
<td>if an error occured while setting the latency</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.7.6"></a><h4>Permissions</h4>
<p class="permission">Callers need the <code class="literal">org.freedesktop.upower.qos.set-minimum-latency</code> authorization</p>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.5.7.7"></a><h3>
<a name="QoS.RequestLatency"></a>RequestLatency ()</h3>
<pre class="programlisting">RequestLatency (in's'type,
in'i'value,
in'b'persistent,
out'u'cookie)</pre>
</div>
<p>
            Set the required latency of an application or service.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>:</span></p></td>
<td>
            The type of latency to control, <code class="literal">cpu_dma</code> or
            <code class="literal">network</code>.
          </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>:</span></p></td>
<td>
            The value, in microseconds or kilobits per second.
            The value <code class="literal">-1</code> means remove all latency requirements.
          </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>persistent</code></em>:</span></p></td>
<td>
            If the latency request outlives the connection.
            When the application issuing the request disconnects from the system
            bus, the latency request is automatically cleaned up.
            By setting this flag to TRUE, the request is not cleaned up when
            the client disconnects, and the cookie is preserved acress reboots.
          </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cookie</code></em>:</span></p></td>
<td>
            A cookie that identifies the request. This allows an application or
            service to request multiple latency settings from one process, and for
            other processes to cancel requests.
          </td>
</tr>
</tbody>
</table></div>
<div class="refsect3">
<a name="id-1.2.5.7.10"></a><h4>Errors</h4>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>org.freedesktop.UPower.GeneralError</code></em>:</span></p></td>
<td>if an error occured while setting the latency</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.7.11"></a><h4>Permissions</h4>
<p class="permission">
          Callers need the
          <code class="literal">org.freedesktop.upower.qos.request-latency-persistent</code>
          authorization if <code class="literal">persistent</code> is TRUE, or
          <code class="literal">org.freedesktop.upower.qos.request-latency</code> otherwise.
        </p>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.5.7.12"></a><h3>
<a name="QoS.CancelRequest"></a>CancelRequest ()</h3>
<pre class="programlisting">CancelRequest (in'u'cookie)</pre>
</div>
<p>
            Cancel the latency request from the application or service.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cookie</code></em>:</span></p></td>
<td>
            A cookie that identifies the request. This allows an application or
            serivice to request multiple latency settings from one process.
          </td>
</tr></tbody>
</table></div>
<div class="refsect3">
<a name="id-1.2.5.7.15"></a><h4>Errors</h4>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>org.freedesktop.UPower.GeneralError</code></em>:</span></p></td>
<td>if an error occured while clearing the latency</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.7.16"></a><h4>Permissions</h4>
<p class="permission">
          Callers need the
          <code class="literal">org.freedesktop.upower.qos.cancel-request</code>
          authorization if they were not the one issuing the request.
        </p>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.5.7.17"></a><h3>
<a name="QoS.GetLatency"></a>GetLatency ()</h3>
<pre class="programlisting">GetLatency (in's'type,
out'i'value)</pre>
</div>
<p>
            Get the lowest latency state on the system at the current time.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>:</span></p></td>
<td>
            The type of latency to return, <code class="literal">cpu_dma</code> or
            <code class="literal">network</code>.
          </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>:</span></p></td>
<td>
            The value, in microseconds or kilobits per second.
            The value <code class="literal">-1</code> means not set or unavailable.
          </td>
</tr>
</tbody>
</table></div>
<div class="refsect3">
<a name="id-1.2.5.7.20"></a><h4>Errors</h4>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>org.freedesktop.UPower.GeneralError</code></em>:</span></p></td>
<td>if an error occured while getting the latency</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.5.7.21"></a><h3>
<a name="QoS.GetLatencyRequests"></a>GetLatencyRequests ()</h3>
<pre class="programlisting">GetLatencyRequests (out'a(uuusxbssi)'requests)</pre>
</div>
<p>
            Gets all the system requests from all services and applications.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>requests</code></em>:</span></p></td>
<td>
            The request lists, where each application can request different
            latency types.
            <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<span class="bold"><strong>cookie: </strong></span>
                  The random cookie that identifies the request.
                </li>
<li class="listitem">
<span class="bold"><strong>uid: </strong></span>
                  The user ID that issued the request.
                </li>
<li class="listitem">
<span class="bold"><strong>pid: </strong></span>
                  The process ID of the application.
                </li>
<li class="listitem">
<span class="bold"><strong>exec: </strong></span>
                  The executable that issued the request.
                </li>
<li class="listitem">
<span class="bold"><strong>timespec: </strong></span>
                  The number of seconds since the epoch.
                </li>
<li class="listitem">
<span class="bold"><strong>persistent: </strong></span>
                  If the request is persistent and outlives the connection lifetime.
                </li>
<li class="listitem">
<span class="bold"><strong>type: </strong></span>
                  The type of the request, <code class="literal">cpu_dma</code> or
                  <code class="literal">network</code>.
                </li>
<li class="listitem">
<span class="bold"><strong>value: </strong></span>
                  The value, in microseconds or kilobits per second.
                </li>
</ul></div>
        </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="id-1.2.5.8"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="id-1.2.5.8.2"></a><h3>
<a name="QoS::LatencyChanged"></a>The LatencyChanged signal</h3>
<pre class="programlisting">LatencyChanged ('s'type,
'i'value)</pre>
</div>
<p>
            Some latency value has changed.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>:</span></p></td>
<td>
            The type of latency that changed, cpu_dma or
            network.
          </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em>:</span></p></td>
<td>
            The value, in microseconds or kilobits per second.
            The value -1 means not set or unavailable.
          </td>
</tr>
</tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="id-1.2.5.8.5"></a><h3>
<a name="QoS::RequestsChanged"></a>The RequestsChanged signal</h3>
<pre class="programlisting">RequestsChanged ()</pre>
</div>
<p>
            The latency requests on the system have changed.
          </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>