2
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
4
<!ENTITY ERROR_GENERAL "org.freedesktop.UPower.GeneralError">
6
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
7
<interface name="org.freedesktop.UPower.QoS">
11
org.freedesktop.UPower.QoS is a DBus interface implimented
13
It allows applications to request latencies, for example a couple of seconds
14
for an IM application, or a few hundred microseconds for a multiplayer game.
22
I want my IM application to request 0.5s latency for messages.
25
I'm running an OpenGL simulation and want maximum performance,
26
even when on battery power.
29
I'm running an SQL server for a credit card company, and want the
30
server to request low latency CPU and network as any delay costs money.
33
I'm an admin, and want to change the power consumption vs. latency
34
from cron scripts so it uses high latency during the night for
35
maximum power saving, and low latency during business hours.
38
I want high throughput when copying files, but want low throughput
39
for downloading updates in the background.
42
I want my power manager to set all latencies to lowest when on
46
I don't want my users messing with latency settings.
49
I'm and admin and I want to be able to override all latency
50
settings on my machines.
55
Why don't applications use the PMQoS interface directly?
56
By providing a framework we can override requests by policy, and also
57
control requests from random services.
58
You also can't set latencies unless you're the root user, which is not
59
suitable for the desktop use case.
62
Of course, you can do if you really want, but then you loose the
63
benefits of the query interface and the policy override,
64
and have to run your application as root.
69
<!-- ************************************************************ -->
70
<method name="SetMinimumLatency">
71
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
72
<arg name="type" direction="in" type="s">
75
The type of latency to control, <doc:tt>cpu_dma</doc:tt> or
76
<doc:tt>network</doc:tt>.
80
<arg name="value" direction="in" type="i">
83
The value, in microseconds or kilobits per second.
84
The value <doc:tt>-1</doc:tt> means unset and the default is used.
91
Set the minimum acceptable latency of the system.
92
Setting this value tells the system to not attempt latencies below this setting.
93
This may be useful in a data center or server room, when you want to override the
94
latency requests from applications.
95
This may be required if the server room is operating outside a standard thermal
96
or power envelope, and an override is required.
97
You do not have to use this method during normal operation.
100
<doc:permission>Callers need the <doc:tt>org.freedesktop.upower.qos.set-minimum-latency</doc:tt> authorization</doc:permission>
102
<doc:error name="&ERROR_GENERAL;">if an error occured while setting the latency</doc:error>
107
<!-- ************************************************************ -->
108
<method name="RequestLatency">
109
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
110
<arg name="type" direction="in" type="s">
113
The type of latency to control, <doc:tt>cpu_dma</doc:tt> or
114
<doc:tt>network</doc:tt>.
118
<arg name="value" direction="in" type="i">
121
The value, in microseconds or kilobits per second.
122
The value <doc:tt>-1</doc:tt> means remove all latency requirements.
126
<arg name="persistent" direction="in" type="b">
129
If the latency request outlives the connection.
130
When the application issuing the request disconnects from the system
131
bus, the latency request is automatically cleaned up.
132
By setting this flag to TRUE, the request is not cleaned up when
133
the client disconnects, and the cookie is preserved acress reboots.
137
<arg name="cookie" direction="out" type="u">
140
A cookie that identifies the request. This allows an application or
141
service to request multiple latency settings from one process, and for
142
other processes to cancel requests.
149
Set the required latency of an application or service.
154
<doc:tt>org.freedesktop.upower.qos.request-latency-persistent</doc:tt>
155
authorization if <doc:tt>persistent</doc:tt> is TRUE, or
156
<doc:tt>org.freedesktop.upower.qos.request-latency</doc:tt> otherwise.
159
<doc:error name="&ERROR_GENERAL;">if an error occured while setting the latency</doc:error>
164
<!-- ************************************************************ -->
165
<method name="CancelRequest">
166
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
167
<arg name="type" direction="in" type="s">
170
The type of latency to control, <doc:tt>cpu_dma</doc:tt> or
171
<doc:tt>network</doc:tt>.
175
<arg name="cookie" direction="in" type="u">
178
A cookie that identifies the request. This allows an application or
179
serivice to request multiple latency settings from one process.
186
Cancel the latency request from the application or service.
191
<doc:tt>org.freedesktop.upower.qos.cancel-request</doc:tt>
192
authorization if they were not the one issuing the request.
195
<doc:error name="&ERROR_GENERAL;">if an error occured while clearing the latency</doc:error>
200
<!-- ************************************************************ -->
201
<method name="GetLatency">
202
<arg name="type" direction="in" type="s">
205
The type of latency to return, <doc:tt>cpu_dma</doc:tt> or
206
<doc:tt>network</doc:tt>.
210
<arg name="value" direction="out" type="i">
213
The value, in microseconds or kilobits per second.
214
The value <doc:tt>-1</doc:tt> means not set or unavailable.
221
Get the lowest latency state on the system at the current time.
225
<doc:error name="&ERROR_GENERAL;">if an error occured while getting the latency</doc:error>
230
<!-- ************************************************************ -->
231
<signal name="LatencyChanged">
232
<arg name="type" direction="out" type="s">
235
The type of latency that changed, <doc:tt>cpu_dma</doc:tt> or
236
<doc:tt>network</doc:tt>.
240
<arg name="value" direction="out" type="i">
243
The value, in microseconds or kilobits per second.
244
The value <doc:tt>-1</doc:tt> means not set or unavailable.
251
Some latency value has changed.
257
<!-- ************************************************************ -->
258
<method name="GetLatencyRequests">
259
<arg name="requests" direction="out" type="a(uuusxbssi)">
262
The request lists, where each application can request different
266
<doc:term>cookie</doc:term>
268
The random cookie that identifies the request.
272
<doc:term>uid</doc:term>
274
The user ID that issued the request.
278
<doc:term>pid</doc:term>
280
The process ID of the application.
284
<doc:term>exec</doc:term>
286
The executable that issued the request.
290
<doc:term>timespec</doc:term>
292
The number of seconds since the epoch.
296
<doc:term>persistent</doc:term>
298
If the request is persistent and outlives the connection lifetime.
302
<doc:term>type</doc:term>
304
The type of the request, <doc:tt>cpu_dma</doc:tt> or
305
<doc:tt>network</doc:tt>.
309
<doc:term>value</doc:term>
311
The value, in microseconds or kilobits per second.
315
</doc:summary></doc:doc>
320
Gets all the system requests from all services and applications.
326
<!-- ************************************************************ -->
327
<signal name="RequestsChanged">
331
The latency requests on the system have changed.
added
removed
src/org.freedesktop.UPower.QoS.xml
