blob: 4167c368202185121a9bb71040d7b17b2cf0374f [file] [log] [blame]
Patrick Williams696fa722016-10-09 15:25:22 -05001description: >
2 An example interface originally described as part of the announcment
3 of new sd-bus interfaces at:
4 http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html
5methods:
6 - name: Multiply
7 description: >
8 Multiplies two integers 'x' and 'y' and returns the result.
9 parameters:
10 - name: x
Patrick Williamsd0cd9662016-11-14 21:55:07 -060011 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050012 description: >
13 The first integer to multiply.
14 - name: y
Patrick Williamsd0cd9662016-11-14 21:55:07 -060015 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050016 description: >
17 The second integer to multiply.
18 default: 1
19 returns:
20 - name: z
Patrick Williamsd0cd9662016-11-14 21:55:07 -060021 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050022 description: >
23 The result of (x*y).
24 - name: Divide
25 description: >
26 Divides two integers 'x' and 'y' and returns the result.
27 parameters:
28 - name: x
Patrick Williamsd0cd9662016-11-14 21:55:07 -060029 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050030 description: >
31 The first integer to divide.
32 - name: y
Patrick Williamsd0cd9662016-11-14 21:55:07 -060033 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050034 description: >
35 The second integer to divide.
36 default: 1
37 returns:
38 - name: z
Patrick Williamsd0cd9662016-11-14 21:55:07 -060039 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050040 description: >
41 The result of (x/y).
42 errors:
43 - self.DivisionByZero
44 - name: Clear
45 description: >
46 Reset the LastResult property to zero.
47properties:
48 - name: LastResult
Patrick Williamsd0cd9662016-11-14 21:55:07 -060049 type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050050 default: 0
51 description: >
52 The result of the most recent calculation.
53signals:
54 - name: Cleared
55 description: >
56 Signal indicating the LastReset property has been set to zero by the
57 'Clear' method.
58 properties:
Patrick Williamsd0cd9662016-11-14 21:55:07 -060059 - type: int64
Patrick Williams696fa722016-10-09 15:25:22 -050060 description: >
61 Value of LastReset prior to Clear.
62