← Back to branch summary

~xavi-garcia-mena/ubuntu/vivid/upower/percentages-power-off

« back to all changes in this revision

Viewing changes to src/org.freedesktop.UPower.Wakeups.xml

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2010-02-16 10:16:24 UTC
  • Revision ID: james.westby@ubuntu.com-20100216101624-2cmwqsr1ndftdd87
Tags: upstream-0.9.0+git20100216.72bb2
Import upstream version 0.9.0+git20100216.72bb2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org.freedesktop.UPower.Wakeups.xml
 
1
<!DOCTYPE node PUBLIC
 
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">
 
5
]>
 
6
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
 
7
  <interface name="org.freedesktop.UPower.Wakeups">
 
8
    <doc:doc>
 
9
      <doc:description>
 
10
        <doc:para>
 
11
          org.freedesktop.UPower.Wakeups is a DBus interface implimented
 
12
          by DeviceKit-power.
 
13
          It allows applications to watch what applications and drivers are
 
14
          causing the wakeups on the system.
 
15
        </doc:para>
 
16
      </doc:description>
 
17
    </doc:doc>
 
18
 
 
19
    <property name="HasCapability" type="b" access="read">
 
20
      <doc:doc>
 
21
        <doc:description>
 
22
          <doc:para>
 
23
            If the system has the ability to profile wakeups.
 
24
          </doc:para>
 
25
        </doc:description>
 
26
      </doc:doc>
 
27
    </property>
 
28
 
 
29
    <!-- ************************************************************ -->
 
30
    <method name="GetTotal">
 
31
      <arg name="value" direction="out" type="u">
 
32
        <doc:doc>
 
33
          <doc:summary>
 
34
            The number of wakeups per second.
 
35
          </doc:summary>
 
36
        </doc:doc>
 
37
      </arg>
 
38
      <doc:doc>
 
39
        <doc:description>
 
40
          <doc:para>
 
41
            Get the number of wakeups per second.
 
42
          </doc:para>
 
43
        </doc:description>
 
44
        <doc:errors>
 
45
          <doc:error name="&ERROR_GENERAL;">if an error occured while getting the latency</doc:error>
 
46
        </doc:errors>
 
47
      </doc:doc>
 
48
    </method>
 
49
 
 
50
    <!-- ************************************************************ -->
 
51
    <signal name="TotalChanged">
 
52
      <arg name="value" direction="out" type="u">
 
53
        <doc:doc>
 
54
          <doc:summary>
 
55
            The number of wakeups per second.
 
56
          </doc:summary>
 
57
        </doc:doc>
 
58
      </arg>
 
59
      <doc:doc>
 
60
        <doc:description>
 
61
          <doc:para>
 
62
            The number of wakeups per second has changed.
 
63
          </doc:para>
 
64
        </doc:description>
 
65
      </doc:doc>
 
66
    </signal>
 
67
 
 
68
    <!-- ************************************************************ -->
 
69
    <method name="GetData">
 
70
      <arg name="data" direction="out" type="a(budss)">
 
71
        <doc:doc>
 
72
          <doc:summary>
 
73
            The data of all the processes and drivers which contribute to the
 
74
            wakeups on the system.
 
75
            <doc:list>
 
76
              <doc:item>
 
77
                <doc:term>is_userspace</doc:term>
 
78
                <doc:definition>
 
79
                  If the wakeup is from userspace.
 
80
                </doc:definition>
 
81
              </doc:item>
 
82
              <doc:item>
 
83
                <doc:term>id</doc:term>
 
84
                <doc:definition>
 
85
                  The process ID of the application, or the IRQ for kernel drivers.
 
86
                </doc:definition>
 
87
              </doc:item>
 
88
              <doc:item>
 
89
                <doc:term>value</doc:term>
 
90
                <doc:definition>
 
91
                  The number of wakeups per second.
 
92
                </doc:definition>
 
93
              </doc:item>
 
94
              <doc:item>
 
95
                <doc:term>cmdline</doc:term>
 
96
                <doc:definition>
 
97
                  The command line for the application, or NULL for kernel drivers.
 
98
                </doc:definition>
 
99
              </doc:item>
 
100
              <doc:item>
 
101
                <doc:term>details</doc:term>
 
102
                <doc:definition>
 
103
                  The details about the wakeup.
 
104
                </doc:definition>
 
105
              </doc:item>
 
106
            </doc:list>
 
107
        </doc:summary></doc:doc>
 
108
      </arg>
 
109
      <doc:doc>
 
110
        <doc:description>
 
111
          <doc:para>
 
112
            Gets all the wakeups from drivers and applications.
 
113
          </doc:para>
 
114
        </doc:description>
 
115
      </doc:doc>
 
116
    </method>
 
117
 
 
118
    <!-- ************************************************************ -->
 
119
    <signal name="DataChanged">
 
120
      <doc:doc>
 
121
        <doc:description>
 
122
          <doc:para>
 
123
            The wakeup data has changed.
 
124
          </doc:para>
 
125
        </doc:description>
 
126
      </doc:doc>
 
127
    </signal>
 
128
 
 
129
  </interface>
 
130
 
 
131
</node>