Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 1 | # -*- Mode: Python -*- |
Marc-André Lureau | d3a4837 | 2017-01-13 15:41:23 +0100 | [diff] [blame] | 2 | |
| 3 | ## |
Markus Armbruster | f5cf31c | 2017-08-24 21:14:08 +0200 | [diff] [blame] | 4 | # = Common data types |
Marc-André Lureau | d3a4837 | 2017-01-13 15:41:23 +0100 | [diff] [blame] | 5 | ## |
Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 6 | |
| 7 | ## |
Marc-André Lureau | 5072f7b | 2016-11-17 19:54:55 +0400 | [diff] [blame] | 8 | # @QapiErrorClass: |
Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 9 | # |
| 10 | # QEMU error classes |
| 11 | # |
| 12 | # @GenericError: this is used for errors that don't require a specific error |
| 13 | # class. This should be the default case for most errors |
| 14 | # |
| 15 | # @CommandNotFound: the requested command has not been found |
| 16 | # |
Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 17 | # @DeviceNotActive: a device has failed to be become active |
| 18 | # |
| 19 | # @DeviceNotFound: the requested device has not been found |
| 20 | # |
| 21 | # @KVMMissingCap: the requested operation can't be fulfilled because a |
| 22 | # required KVM capability is missing |
| 23 | # |
| 24 | # Since: 1.2 |
| 25 | ## |
Eric Blake | f22a28b | 2015-11-18 01:53:00 -0700 | [diff] [blame] | 26 | { 'enum': 'QapiErrorClass', |
| 27 | # Keep this in sync with ErrorClass in error.h |
Daniel P. Berrange | c01c214 | 2017-06-23 17:24:16 +0100 | [diff] [blame] | 28 | 'data': [ 'GenericError', 'CommandNotFound', |
Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 29 | 'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] } |
| 30 | |
| 31 | ## |
Markus Armbruster | 2031c13 | 2017-08-24 21:14:06 +0200 | [diff] [blame] | 32 | # @IoOperationType: |
| 33 | # |
| 34 | # An enumeration of the I/O operation types |
| 35 | # |
| 36 | # @read: read operation |
| 37 | # |
| 38 | # @write: write operation |
| 39 | # |
| 40 | # Since: 2.1 |
| 41 | ## |
| 42 | { 'enum': 'IoOperationType', |
| 43 | 'data': [ 'read', 'write' ] } |
| 44 | |
| 45 | ## |
Marc-André Lureau | 5072f7b | 2016-11-17 19:54:55 +0400 | [diff] [blame] | 46 | # @OnOffAuto: |
Don Slutz | d1048be | 2014-11-21 11:18:52 -0500 | [diff] [blame] | 47 | # |
| 48 | # An enumeration of three options: on, off, and auto |
| 49 | # |
| 50 | # @auto: QEMU selects the value between on and off |
| 51 | # |
| 52 | # @on: Enabled |
| 53 | # |
| 54 | # @off: Disabled |
| 55 | # |
| 56 | # Since: 2.2 |
| 57 | ## |
| 58 | { 'enum': 'OnOffAuto', |
| 59 | 'data': [ 'auto', 'on', 'off' ] } |
Matt Gingell | 32c18a2 | 2015-11-16 10:03:06 -0800 | [diff] [blame] | 60 | |
| 61 | ## |
Marc-André Lureau | 5072f7b | 2016-11-17 19:54:55 +0400 | [diff] [blame] | 62 | # @OnOffSplit: |
Matt Gingell | 32c18a2 | 2015-11-16 10:03:06 -0800 | [diff] [blame] | 63 | # |
| 64 | # An enumeration of three values: on, off, and split |
| 65 | # |
| 66 | # @on: Enabled |
| 67 | # |
| 68 | # @off: Disabled |
| 69 | # |
| 70 | # @split: Mixed |
| 71 | # |
| 72 | # Since: 2.6 |
| 73 | ## |
| 74 | { 'enum': 'OnOffSplit', |
| 75 | 'data': [ 'on', 'off', 'split' ] } |
Markus Armbruster | a2ff5a4 | 2017-08-24 21:13:56 +0200 | [diff] [blame] | 76 | |
| 77 | ## |
| 78 | # @String: |
| 79 | # |
| 80 | # A fat type wrapping 'str', to be embedded in lists. |
| 81 | # |
| 82 | # Since: 1.2 |
| 83 | ## |
| 84 | { 'struct': 'String', |
| 85 | 'data': { |
| 86 | 'str': 'str' } } |
Markus Armbruster | 48685a8 | 2017-08-24 21:14:01 +0200 | [diff] [blame] | 87 | |
| 88 | ## |
| 89 | # @StrOrNull: |
| 90 | # |
| 91 | # This is a string value or the explicit lack of a string (null |
| 92 | # pointer in C). Intended for cases when 'optional absent' already |
| 93 | # has a different meaning. |
| 94 | # |
| 95 | # @s: the string value |
| 96 | # @n: no string value |
| 97 | # |
| 98 | # Since: 2.10 |
| 99 | ## |
| 100 | { 'alternate': 'StrOrNull', |
| 101 | 'data': { 's': 'str', |
| 102 | 'n': 'null' } } |