qapi/char: Deprecate backend type "memory"
[qemu/kevin.git] / qapi / sockets.json
blob621315452555f9c6db98a98877fae02ace586871
1 # -*- Mode: Python -*-
2 # vim: filetype=python
4 ##
5 # = Socket data types
6 ##
8 { 'include': 'common.json' }
11 # @NetworkAddressFamily:
13 # The network address family
15 # @ipv4: IPV4 family
17 # @ipv6: IPV6 family
19 # @unix: unix socket
21 # @vsock: vsock family (since 2.8)
23 # @unknown: otherwise
25 # Since: 2.1
27 { 'enum': 'NetworkAddressFamily',
28   'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] }
31 # @InetSocketAddressBase:
33 # @host: host part of the address
34 # @port: port part of the address
36 { 'struct': 'InetSocketAddressBase',
37   'data': {
38     'host': 'str',
39     'port': 'str' } }
42 # @InetSocketAddress:
44 # Captures a socket address or address range in the Internet
45 # namespace.
47 # @numeric: true if the host/port are guaranteed to be numeric, false
48 #     if name resolution should be attempted.  Defaults to false.
49 #     (Since 2.9)
51 # @to: If present, this is range of possible addresses, with port
52 #     between @port and @to.
54 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and
55 #     IPv6
57 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and
58 #     IPv6
60 # @keep-alive: enable keep-alive when connecting to this socket.  Not
61 #     supported for passive sockets.  (Since 4.2)
63 # @mptcp: enable multi-path TCP. (Since 6.1)
65 # Since: 1.3
67 { 'struct': 'InetSocketAddress',
68   'base': 'InetSocketAddressBase',
69   'data': {
70     '*numeric':  'bool',
71     '*to': 'uint16',
72     '*ipv4': 'bool',
73     '*ipv6': 'bool',
74     '*keep-alive': 'bool',
75     '*mptcp': { 'type': 'bool', 'if': 'HAVE_IPPROTO_MPTCP' } } }
78 # @UnixSocketAddress:
80 # Captures a socket address in the local ("Unix socket") namespace.
82 # @path: filesystem path to use
84 # @abstract: if true, this is a Linux abstract socket address.  @path
85 #     will be prefixed by a null byte, and optionally padded with null
86 #     bytes.  Defaults to false.  (Since 5.1)
88 # @tight: if false, pad an abstract socket address with enough null
89 #     bytes to make it fill struct sockaddr_un member sun_path.
90 #     Defaults to true.  (Since 5.1)
92 # Since: 1.3
94 { 'struct': 'UnixSocketAddress',
95   'data': {
96     'path': 'str',
97     '*abstract': { 'type': 'bool', 'if': 'CONFIG_LINUX' },
98     '*tight': { 'type': 'bool', 'if': 'CONFIG_LINUX' } } }
101 # @VsockSocketAddress:
103 # Captures a socket address in the vsock namespace.
105 # @cid: unique host identifier
107 # @port: port
109 # Note: string types are used to allow for possible future hostname or
110 #     service resolution support.
112 # Since: 2.8
114 { 'struct': 'VsockSocketAddress',
115   'data': {
116     'cid': 'str',
117     'port': 'str' } }
120 # @InetSocketAddressWrapper:
122 # Since: 1.3
124 { 'struct': 'InetSocketAddressWrapper',
125   'data': { 'data': 'InetSocketAddress' } }
128 # @UnixSocketAddressWrapper:
130 # Since: 1.3
132 { 'struct': 'UnixSocketAddressWrapper',
133   'data': { 'data': 'UnixSocketAddress' } }
136 # @VsockSocketAddressWrapper:
138 # Since: 2.8
140 { 'struct': 'VsockSocketAddressWrapper',
141   'data': { 'data': 'VsockSocketAddress' } }
144 # @StringWrapper:
146 # Since: 1.3
148 { 'struct': 'StringWrapper',
149   'data': { 'data': 'String' } }
152 # @SocketAddressLegacy:
154 # Captures the address of a socket, which could also be a named file
155 # descriptor
157 # Note: This type is deprecated in favor of SocketAddress.  The
158 #     difference between SocketAddressLegacy and SocketAddress is that
159 #     the latter has fewer {} on the wire.
161 # Since: 1.3
163 { 'union': 'SocketAddressLegacy',
164   'base': { 'type': 'SocketAddressType' },
165   'discriminator': 'type',
166   'data': {
167     'inet': 'InetSocketAddressWrapper',
168     'unix': 'UnixSocketAddressWrapper',
169     'vsock': 'VsockSocketAddressWrapper',
170     'fd': 'StringWrapper' } }
173 # @SocketAddressType:
175 # Available SocketAddress types
177 # @inet: Internet address
179 # @unix: Unix domain socket
181 # @vsock: VMCI address
183 # @fd: decimal is for file descriptor number, otherwise a file
184 #     descriptor name.  Named file descriptors are permitted in
185 #     monitor commands, in combination with the 'getfd' command.
186 #     Decimal file descriptors are permitted at startup or other
187 #     contexts where no monitor context is active.
189 # Since: 2.9
191 { 'enum': 'SocketAddressType',
192   'data': [ 'inet', 'unix', 'vsock', 'fd' ] }
195 # @SocketAddress:
197 # Captures the address of a socket, which could also be a named file
198 # descriptor
200 # @type: Transport type
202 # Since: 2.9
204 { 'union': 'SocketAddress',
205   'base': { 'type': 'SocketAddressType' },
206   'discriminator': 'type',
207   'data': { 'inet': 'InetSocketAddress',
208             'unix': 'UnixSocketAddress',
209             'vsock': 'VsockSocketAddress',
210             'fd': 'String' } }