| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 1 | description: > |
| Gunnar Mills | a4b4a0b | 2018-04-08 14:30:38 -0500 | [diff] [blame] | 2 | An example interface originally described as part of the announcement |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 3 | of new sd-bus interfaces at: |
| 4 | http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html |
| 5 | methods: |
| 6 | - name: Multiply |
| 7 | description: > |
| 8 | Multiplies two integers 'x' and 'y' and returns the result. |
| 9 | parameters: |
| 10 | - name: x |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 11 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 12 | description: > |
| 13 | The first integer to multiply. |
| 14 | - name: y |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 15 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 16 | description: > |
| 17 | The second integer to multiply. |
| 18 | default: 1 |
| 19 | returns: |
| 20 | - name: z |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 21 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 22 | 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 Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 29 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 30 | description: > |
| 31 | The first integer to divide. |
| 32 | - name: y |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 33 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 34 | description: > |
| 35 | The second integer to divide. |
| 36 | default: 1 |
| 37 | returns: |
| 38 | - name: z |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 39 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 40 | description: > |
| 41 | The result of (x/y). |
| 42 | errors: |
| Patrick Williams | 4a5c3b3 | 2016-11-15 14:26:25 -0600 | [diff] [blame] | 43 | - self.Error.DivisionByZero |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 44 | - name: Clear |
| Waqar Hameed | 3e3a665 | 2020-06-04 10:51:18 +0200 | [diff] [blame] | 45 | flags: |
| 46 | - unprivileged |
| 47 | - no_reply |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 48 | description: > |
| 49 | Reset the LastResult property to zero. |
| 50 | properties: |
| 51 | - name: LastResult |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 52 | type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 53 | default: 0 |
| 54 | description: > |
| 55 | The result of the most recent calculation. |
| Patrick Williams | 8c00fed | 2016-11-15 11:07:39 -0600 | [diff] [blame] | 56 | - name: Status |
| 57 | type: enum[self.State] |
| 58 | default: Success |
| Adriana Kobylak | 69425eb | 2018-08-17 13:55:19 -0500 | [diff] [blame] | 59 | flags: |
| 60 | - const |
| Patrick Williams | 8c00fed | 2016-11-15 11:07:39 -0600 | [diff] [blame] | 61 | description: > |
| 62 | The current state of the Calculator. |
| Adriana Kobylak | 75a2e25 | 2018-06-06 10:49:24 -0500 | [diff] [blame] | 63 | - name: Owner |
| 64 | type: string |
| 65 | description: > |
| 66 | The name of the owner of the Calculator. |
| 67 | errors: |
| 68 | - self.Error.PermissionDenied |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 69 | signals: |
| 70 | - name: Cleared |
| 71 | description: > |
| 72 | Signal indicating the LastReset property has been set to zero by the |
| 73 | 'Clear' method. |
| 74 | properties: |
| Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 75 | - type: int64 |
| Patrick Williams | 696fa72 | 2016-10-09 15:25:22 -0500 | [diff] [blame] | 76 | description: > |
| 77 | Value of LastReset prior to Clear. |
| Patrick Williams | 8c00fed | 2016-11-15 11:07:39 -0600 | [diff] [blame] | 78 | enumerations: |
| 79 | - name: State |
| 80 | description: > |
| 81 | Identifies if the service has encountered an error or not. |
| 82 | values: |
| 83 | - name: Success |
| 84 | description: > |
| 85 | No error has been encountered. |
| 86 | - name: Error |
| 87 | description: > |
| 88 | The service has encountered an error. |