summaryrefslogtreecommitdiff
path: root/src/org.freedesktop.UPower.Wakeups.xml
blob: 82477f462f176d7926faf49ee5666e413d267ff6 (plain)
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
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
  <!ENTITY ERROR_GENERAL "org.freedesktop.UPower.GeneralError">
]>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <interface name="org.freedesktop.UPower.Wakeups">
    <doc:doc>
      <doc:description>
        <doc:para>
          org.freedesktop.UPower.Wakeups is a DBus interface implimented
          by UPower.
          It allows applications to watch what applications and drivers are
          causing the wakeups on the system.
        </doc:para>
      </doc:description>
    </doc:doc>

    <property name="HasCapability" type="b" access="read">
      <doc:doc>
        <doc:description>
          <doc:para>
            If the system has the ability to profile wakeups.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!-- ************************************************************ -->
    <method name="GetTotal">
      <arg name="value" direction="out" type="u">
        <doc:doc>
          <doc:summary>
            The number of wakeups per second.
          </doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Get the number of wakeups per second.
          </doc:para>
        </doc:description>
        <doc:errors>
          <doc:error name="&ERROR_GENERAL;">if an error occured while getting the latency</doc:error>
        </doc:errors>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->
    <signal name="TotalChanged">
      <arg name="value" direction="out" type="u">
        <doc:doc>
          <doc:summary>
            The number of wakeups per second.
          </doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            The number of wakeups per second has changed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

    <!-- ************************************************************ -->
    <method name="GetData">
      <arg name="data" direction="out" type="a(budss)">
        <doc:doc>
          <doc:summary>
            The data of all the processes and drivers which contribute to the
            wakeups on the system.
            <doc:list>
              <doc:item>
                <doc:term>is_userspace</doc:term>
                <doc:definition>
                  If the wakeup is from userspace.
                </doc:definition>
              </doc:item>
              <doc:item>
                <doc:term>id</doc:term>
                <doc:definition>
                  The process ID of the application, or the IRQ for kernel drivers.
                </doc:definition>
              </doc:item>
              <doc:item>
                <doc:term>value</doc:term>
                <doc:definition>
                  The number of wakeups per second.
                </doc:definition>
              </doc:item>
              <doc:item>
                <doc:term>cmdline</doc:term>
                <doc:definition>
                  The command line for the application, or NULL for kernel drivers.
                </doc:definition>
              </doc:item>
              <doc:item>
                <doc:term>details</doc:term>
                <doc:definition>
                  The details about the wakeup.
                </doc:definition>
              </doc:item>
            </doc:list>
        </doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Gets all the wakeups from drivers and applications.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->
    <signal name="DataChanged">
      <doc:doc>
        <doc:description>
          <doc:para>
            The wakeup data has changed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

  </interface>

</node>